The official Invidious documentation
Go to file
Samantaz Fox dca939835c
Update channels api docs (#326)
* Add a page specifying common object types

* Add a page for the /api/v1/channels endpoint

* Remove obselete definitions from api.md

* Add/update links in index.md and mkdocs.yml

* Impove MkDocs config to support code highlight & copy button

* Use native JS types for better syntax highlighting
2023-01-14 12:01:24 +01:00
.github Reword the automatic restart explanation 2022-08-31 12:03:38 +02:00
docs Update channels api docs (#326) 2023-01-14 12:01:24 +01: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 Update channels api docs (#326) 2023-01-14 12:01:24 +01:00
README.md Add README instructions for serving the docs locally (#287) 2022-11-27 20:09:49 +01:00

The Invidious documentation

Running the documentation locally for development purposes

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