The official Invidious documentation
Go to file
ChunkyProgrammer bd5c262fb1
Update api documentation with new endpoints and fixes (#501)
* Fix documentation on search's `sort` parameter

* remove `news` from trending type

* Remove channels/comments documentation

* Remove channels search documentation from api.md page

* add missing endpoints

* fix `resolveurl` name

* update param description for community post comments

* update `search-filters.md` and `url-parameters.md` to include api changes
2024-06-26 10:08:11 +02:00
.github upd: added .ip2 network control for workflows. (#561) 2024-06-10 08:43:04 +02:00
docs Update api documentation with new endpoints and fixes (#501) 2024-06-26 10:08:11 +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 Fix admonition on 'Database maintenance' page (#431) 2023-12-03 16:06:50 +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