diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..d19c590b --- /dev/null +++ b/docs/README.md @@ -0,0 +1,20 @@ +# node-postgres docs website + +This is the documentation for node-postgres which is currently hosted at [https://node-postgres.com](https://node-postgres.com). + +## Development + +To run the documentation locally, you need to have [Node.js](https://nodejs.org) installed. Then, you can clone the repository and install the dependencies: + +```bash +cd docs +yarn +``` + +Once you've installed the deps, you can run the development server: + +```bash +yarn dev +``` + +This will start a local server at [http://localhost:3000](http://localhost:3000) where you can view the documentation and see your changes. diff --git a/docs/theme.config.js b/docs/theme.config.js index 02e5327c..5ba74b52 100644 --- a/docs/theme.config.js +++ b/docs/theme.config.js @@ -10,7 +10,6 @@ export default { docsRepositoryBase: 'https://github.com/brianc/node-postgres/blob/master/docs', // base URL for the docs repository titleSuffix: ' – node-postgres', darkMode: true, - footer: true, navigation: { prev: true, next: true, @@ -23,7 +22,6 @@ export default { }, logo: ( <> - ... node-postgres ),