mirror of
https://github.com/iv-org/documentation.git
synced 2025-11-23 01:01:57 -05:00
The official Invidious documentation
9aa594834a
* Update podman quadlet docs to include companion The prior documentation appears to predate the introduction of the companion container. This commit adapts the instructions to include the new companion and some improved formatting. * fix admonition * correct contributor name Some of lzap's original wording remains, but the guidance has been rewritten from scratch. Perhaps their username should remain for some time longer, but they noted that they no longer use Invidious #602 also. * comment out conflicting env var * set SELinux label for volumes `:Z` means the volume is not shared between containers. `:z` allows other containers to share the volume, implying read/write. Most volumes should be labeled `:Z` unless the volume must be shared between multiple containers. |
||
|---|---|---|
| .github | ||
| docs | ||
| Dockerfile | ||
| LICENSE | ||
| mkdocs.yml | ||
| README.md | ||
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