The official Invidious documentation
Find a file
Stephen Fasciani b806efa844
Reword document for grammar and mkdocs
This PR rewords the Invidious Companion Guide to be more authoritative and corrects grammar. It also adds mkdocs compatible callouts and increases readability.
2025-05-23 15:55:25 -04:00
.github Add perennialtech and bugmaschine to the Assignees list when opening a new instance Issue (#589) 2024-08-31 02:00:11 +02:00
docs Reword document for grammar and mkdocs 2025-05-23 15:55:25 -04: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 add devtools tutorial (#626) 2025-01-02 14:39:08 +01:00
README.md remove part about browserstack open source program 2025-01-03 20:54:07 +01:00

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