To preview local changes, first install MkDocs
pip3 install --user mkdocs
mkdocs can't be found after the installation, the $PATH might have not
been set correctly yet. Try opening a new terminal session.
Then go to the build directory and run
make doc INFO - Cleaning site directory INFO - Building documentation to directory: /home/vagrant/build/site-html
mkdocs build plus extra transformation of some files and adds
CMakeLists.txt for the exact steps).
Now you can start webserver for local testing
build> mkdocs serve [server:296] Serving on http://127.0.0.1:8000 [handlers:62] Start watching changes
If you develop inside a Vagrant virtual machine:
- add port forwarding to your Vagrantfile,
config.vm.network "forwarded_port", guest: 8000, host: 8000
mkdocs serve --dev-addr 0.0.0.0:8000because the default localhost IP does not get forwarded.