From c707d9c278f478d7877c27f498e34cd5e977d47c Mon Sep 17 00:00:00 2001 From: Valentin Gagarin Date: Fri, 12 Apr 2024 15:32:51 +0200 Subject: [PATCH] add instructions to live reload docs --- CONTRIBUTING.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..d2c520886 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,21 @@ +# Contributing to cLAN + +## Live-reloading documentation + +Enter the `docs` directory: + +```shell-session +cd docs +``` + +Enter the development shell or enable `direnv`: + +```shell-session +direnv allow +``` + +Run a local server: + +```shell-session +mkdocs serve +```