The official Invidious documentation
Go to file
ChunkyProgrammer 4d7250c23c
Remove references to `fields` and `pretty` (#500)
2024-04-15 18:12:56 +02:00
.github Edit the new instance message about joining the instance owners room (#536) 2024-04-15 15:58:00 +02:00
docs Remove references to `fields` and `pretty` (#500) 2024-04-15 18:12:56 +02: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 Fix admonition on 'Database maintenance' page (#431) 2023-12-03 16:06:50 +01: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