The official Invidious documentation
Go to file
Mateusz Bączek 7fd4b15814
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>
2022-11-27 20:09:49 +01:00
.github Reword the automatic restart explanation 2022-08-31 12:03:38 +02:00
docs Update ~vern invidious location (#311) 2022-11-26 17:14:27 +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
mkdocs.yml Improve navigation (#243) 2022-06-01 02:57:57 +02:00
README.md Add README instructions for serving the docs locally (#287) 2022-11-27 20:09:49 +01:00

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