The official Invidious documentation
Go to file
perennial d9f05c51e8
Clarify public instance rules and definition of analytics (#565)
* Add section 'Rules for public instances'

* Clarify that all external scripts are prohibited

* Rename section 'Rules to have your instance in this list:'

* Update link to rules in new instance proposal

* Don't change the title, since public instances can also not be in the list

---------

Co-authored-by: TheFrenchGhosty <47571719+TheFrenchGhosty@users.noreply.github.com>
2024-07-20 18:11:54 +02:00
.github Clarify public instance rules and definition of analytics (#565) 2024-07-20 18:11:54 +02:00
docs Clarify public instance rules and definition of analytics (#565) 2024-07-20 18:11:54 +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 Release a tutorial to make Invidious requests data from YouTube through a VPN using Gluetun (#575) 2024-07-19 16:40:52 +02: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