Skip to content

Commit c97f0ae

Browse files
author
Brian Carlson
committed
Update docs - start
1 parent 9cc7d8e commit c97f0ae

File tree

2 files changed

+20
-2
lines changed

2 files changed

+20
-2
lines changed

docs/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# node-postgres docs website
2+
3+
This is the documentation for node-postgres which is currently hosted at [https://node-postgres.com](https://node-postgres.com).
4+
5+
## Development
6+
7+
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:
8+
9+
```bash
10+
cd docs
11+
yarn
12+
```
13+
14+
Once you've installed the deps, you can run the development server:
15+
16+
```bash
17+
yarn dev
18+
```
19+
20+
This will start a local server at [http://localhost:3000](http://localhost:3000) where you can view the documentation and see your changes.

docs/theme.config.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ export default {
1010
docsRepositoryBase: 'https://github.com/brianc/node-postgres/blob/master/docs', // base URL for the docs repository
1111
titleSuffix: ' – node-postgres',
1212
darkMode: true,
13-
footer: true,
1413
navigation: {
1514
prev: true,
1615
next: true,
@@ -23,7 +22,6 @@ export default {
2322
},
2423
logo: (
2524
<>
26-
<svg>...</svg>
2725
<span>node-postgres</span>
2826
</>
2927
),

0 commit comments

Comments
 (0)