About
This repository contains source code for Fobnail Documentation webpage
Local development
Environment setup
$ virtualenv -p $(which python3) venv
$ source venv/bin/activate
$(venv) pip install mkdocs mkdocs-material
Build
$(venv) mkdocs build
Preview
$(venv) mkdocs serve
pre-commit hooks
-
Install hooks into repo:
pre-commit install
-
Enjoy automatic checks on each
git commit
action! -
(Optional) Run hooks on all files (for example, when adding new hooks or configuring existing ones):
pre-commit run --all-files
Contribution
Please use GitHub Pull Request
and Issues
to collaborate.