add instructions to live reload docs
This commit is contained in:
committed by
Johannes Kirschbauer
parent
a7e8500d99
commit
c707d9c278
21
CONTRIBUTING.md
Normal file
21
CONTRIBUTING.md
Normal file
@@ -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
|
||||||
|
```
|
||||||
Reference in New Issue
Block a user