From 2f25ca490c8691fe328935dbcd0677f56c9ef21b Mon Sep 17 00:00:00 2001 From: Christian Bager Bach Houmann <christian@bagerbach.com> Date: Mon, 14 Nov 2022 11:00:00 +0100 Subject: [PATCH] document docs install & dev process --- docs/README.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..5f8562c --- /dev/null +++ b/docs/README.md @@ -0,0 +1,9 @@ +Install `mkdocs` and `mkdocs-material` with `pip`. + +``` +pip install mkdocs mkdocs-material +``` + +To build the documentation, run `mkdocs build` in the root directory of the repository. + +To serve the documentation locally, run `mkdocs serve` in the root directory of the repository. \ No newline at end of file -- GitLab