Deployment at: https://purdueaerialroboticsteam.github.io/feonix-docs/
This repository is based off of mkdocs-plantuml-c4
This repository provides a nix flake that builds and serves an the feonix project documentation that is written in markdown and generated as HTML by the mkdocs tool. It bundles multiple plugins in a handy way so you don't have to do this yourself for every computer you use it on.
To view the generated config offline without installing or cloning anything, run:
nix run github:PurdueAerialRoboticsTeam/feonix-docsIf you use ssh keys, please use
git+ssh://[email protected]/PurdueAerialRoboticsTeam/feonix-docs instead.
To view the checked-out version, clone the repository and from inside, run:
nix develop
mkdocs serveYou can also build a PDF version of the docs:
# without local checkout
nix build github:PurdueAerialRoboticsTeam/feonix-docs#pdf
# local checkout
nix build .#pdf