The official Invidious documentation
Go to file
MintMain21 038036722e
Reformatting Changes to Redirector Documentation (#367)
* Minor change to URL Parameter Documentation URL.

* Reformated Redirection Rules in plaintext to avoid unintentional tranlation errors into Markdown.

* I think I did the formatting right. Also...

I added an additional rule for redirecting Invidious URLs that aren't video players, so that it's easier to enforce sitewide preferences like theme and language.
2023-04-07 23:27:37 +02:00
.github Add mandatory unlimited traffic limit (#316) 2023-03-05 09:39:32 +01:00
docs Reformatting Changes to Redirector Documentation (#367) 2023-04-07 23:27:37 +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
mkdocs.yml Add Caddy web server reverse proxy documentation (#286) 2023-03-05 09:42:47 +01:00
README.md Enhance the README 2023-04-04 17:04:58 +02: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