2022-11-27 19:09:49 +00:00
|
|
|
# The Invidious documentation
|
|
|
|
|
2023-04-04 15:04:58 +00:00
|
|
|
## Running the documentation locally for development purposes
|
2022-11-27 19:09:49 +00:00
|
|
|
|
2023-04-04 15:04:58 +00:00
|
|
|
Run those commands in the repository's folder.
|
|
|
|
|
|
|
|
### Local `mkdocs-material` installation
|
2022-11-27 19:09:49 +00:00
|
|
|
|
|
|
|
```bash
|
|
|
|
# You might want to create a virtualenv first
|
|
|
|
pip install mkdocs-material
|
|
|
|
mkdocs-material serve
|
|
|
|
```
|
|
|
|
|
2023-04-04 15:04:58 +00:00
|
|
|
### With docker
|
2022-11-27 19:09:49 +00:00
|
|
|
|
|
|
|
```bash
|
|
|
|
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material:latest
|
|
|
|
```
|