mirror of
https://github.com/brianc/node-postgres.git
synced 2025-12-08 20:16:25 +00:00
Update docs - start
This commit is contained in:
parent
9cc7d8eb94
commit
c97f0ae367
20
docs/README.md
Normal file
20
docs/README.md
Normal 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.
|
||||
@ -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>
|
||||
</>
|
||||
),
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user