Go to file
Émilien (perso) 049d07e4b8
remind the two important tutorials in the bot comment
2023-11-21 14:28:17 +01:00
.github remind the two important tutorials in the bot comment 2023-11-21 14:28:17 +01:00
docs Use deploy.replicas and variable in proxy_pass in improve-public-instance.md (#469) 2023-11-19 14:38:47 +00:00
Dockerfile Setup CI to build the documentation to a Docker image (#208) 2022-03-12 23:09:51 +01:00
LICENSE Add LICENSE 2020-12-01 18:07:52 +01:00
README.md Enhance the README 2023-04-04 17:04:58 +02:00
mkdocs.yml Add tuto how to improve public instance + rework current pages (#464) 2023-11-04 15:03:31 +00:00

README.md

The Invidious documentation

Running the documentation locally for development purposes

Run those commands in the repository's folder.

Local mkdocs-material installation

# You might want to create a virtualenv first
pip install mkdocs-material
mkdocs-material serve

With docker

docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material:latest