Add README instructions for serving the docs locally (#287)

* Add README instructions for serving the docs locally

* Rename readme.md to README.md

* Add a title

Co-authored-by: TheFrenchGhosty <47571719+TheFrenchGhosty@users.noreply.github.com>
This commit is contained in:
Mateusz Bączek 2022-11-27 20:09:49 +01:00 committed by GitHub
parent 7e5fce94d2
commit 7fd4b15814
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 0 deletions

17
README.md Normal file
View File

@ -0,0 +1,17 @@
# The Invidious documentation
# Running the documentation locally for development purposes
## Local `mkdocs-material` installation
```bash
# You might want to create a virtualenv first
pip install mkdocs-material
mkdocs-material serve
```
## With docker
```bash
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material:latest
```