Skip to content

Commit 5f45ca0

Browse files
committed
Update Readme: serve locally
1 parent 345e70b commit 5f45ca0

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,22 @@ For the source code of Gramps Web, please see
1010
Please use those repositories for reporting issues or feature requests.
1111

1212

13+
## Serving the documentation locally
14+
15+
You can run the website locally and preview it in your browser while editing.
16+
17+
To do that, first install the required Python dependencies (you may want to do this in a virtual environment):
18+
19+
```bash
20+
python -m pip install -r requirements.txt
21+
```
22+
23+
Then, you can serve the documentation and open it in the browser with:
24+
25+
```bash
26+
mkdocs serve -a localhost:8211 -o
27+
```
28+
1329
## Contributing
1430

1531
Contributions to the documentation are welcome! Please see the [Contributing Guide](CONTRIBUTING.md) for details.

0 commit comments

Comments
 (0)