See the site live at https://bhi-research.github.io/
- MkDocs: Project documentation with Markdown
- Material for MkDocs
- Deploying your docs
- Custom domains and GitHub Pages
Linux instructions:
$ python3 -m venv --system-site-packages ./venv-mkdocs
$ source ./venv-mkdocs/bin/activate
(venv-mkdocs) $ pip install --upgrade pip
(venv-mkdocs) $ pip install -r requirements.txt
(venv-mkdocs) $ mkdocs new .
# run
(venv-mkdocs) $ mkdocs serve
# deploy
(venv-mkdocs) $ mkdocs gh-deploy
# when done
(venv-mkdocs) $ deactivate
mkdocs new [dir-name]
- Create a new project.mkdocs serve
- Start the live-reloading docs server.mkdocs build
- Build the documentation site.mkdocs help
- Print this help message.
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.