This repository is replacing https://wiki.ghostbsd.org/.
Each change committed here triggers an automated build that results in an update to the portal:
Automation involves Sphinx, myst-parser, Markdown, and a hook with the portal.
Use a local development server that regenerates the output whenever the input changes:
git clone [email protected]:ghostbsd/documentation.git
sudo pkg install -y py39-pip py39-sphinx py39-myst-parser py39-sphinx_rtd_theme gmake
pip install docutils==0.16
sudo pip install sphinx-autobuild
cd documentation
sphinx-autobuild source build/html
Then, open http://127.0.0.1:8000/index.html in a web browser. It will be regenerated and refreshed whenever a changed file is saved.
One can also generate documentation, in various output formats, locally:
gmake html
gmake epub