Update docs - start

This commit is contained in:
Brian Carlson 2025-04-22 15:25:52 -05:00
parent 9cc7d8eb94
commit c97f0ae367
2 changed files with 20 additions and 2 deletions

20
docs/README.md Normal file
View File

@ -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.

View File

@ -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: (
<>
<svg>...</svg>
<span>node-postgres</span>
</>
),