forked from clan/clan-core
add instructions to live reload docs
This commit is contained in:
parent
1e08a454fb
commit
60f2bf54c3
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
|
||||||
|
```
|
Loading…
Reference in New Issue
Block a user