From 60f2bf54c328e4b7a9d8e93be72edb1ceb4fdad8 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 00000000..d2c52088 --- /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 +```