File tree Expand file tree Collapse file tree 1 file changed +16
-0
lines changed
Expand file tree Collapse file tree 1 file changed +16
-0
lines changed Original file line number Diff line number Diff line change @@ -10,6 +10,22 @@ For the source code of Gramps Web, please see
1010Please 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
1531Contributions to the documentation are welcome! Please see the [ Contributing Guide] ( CONTRIBUTING.md ) for details.
You can’t perform that action at this time.
0 commit comments