Go to file
Emilien Devos fa8610156a add tutorial on how to hide public instance 2023-02-17 22:48:04 +01:00
.github Add comment about matrix room 2023-02-17 11:01:59 +00:00
docs add tutorial on how to hide public instance 2023-02-17 22:48:04 +01: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 Add README instructions for serving the docs locally (#287) 2022-11-27 20:09:49 +01:00
mkdocs.yml add tutorial on how to hide public instance 2023-02-17 22:48:04 +01:00

README.md

The Invidious documentation

Running the documentation locally for development purposes

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