Skip to content

Commit 06f8b08

Browse files
committed
Updated docs to latest upstream
1 parent e80abed commit 06f8b08

File tree

9 files changed

+1853
-88
lines changed

9 files changed

+1853
-88
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,14 @@ To send us a pull request, please follow these steps:
4444
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
4545
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
4646

47+
#### Local documentation
48+
49+
You might find useful to run both the documentation website and the API reference locally while contributing:
50+
51+
* **API reference**: :construction:
52+
* **Docs website**:
53+
- `docs-buildDockerImage` OR `docker build -t squidfunk/mkdocs-material ./docs/`
54+
- `docs-runLocalDocker` OR `docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material`
4755

4856
### Conventions
4957

0 commit comments

Comments
 (0)