Enhance the README
This commit is contained in:
parent
618e0d5f48
commit
a847e516b2
|
@ -1,8 +1,10 @@
|
|||
# The Invidious documentation
|
||||
|
||||
# Running the documentation locally for development purposes
|
||||
## Running the documentation locally for development purposes
|
||||
|
||||
## Local `mkdocs-material` installation
|
||||
Run those commands in the repository's folder.
|
||||
|
||||
### Local `mkdocs-material` installation
|
||||
|
||||
```bash
|
||||
# You might want to create a virtualenv first
|
||||
|
@ -10,7 +12,7 @@ pip install mkdocs-material
|
|||
mkdocs-material serve
|
||||
```
|
||||
|
||||
## With docker
|
||||
### With docker
|
||||
|
||||
```bash
|
||||
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material:latest
|
||||
|
|
Loading…
Reference in New Issue