mirror of
https://github.com/iv-org/documentation.git
synced 2024-12-22 14:05:09 -05:00
The official Invidious documentation
3c2356b9b4
* Remove install for shards shards is not available as a Homebrew package. Instead, it comes with the crystal package. <https://crystal-lang.org/reference/1.12/man/shards/index.html#installation> * Fix postgresql package name * Add createdb Fixes initial error: FATAL: database "<user>" does not exist <https://stackoverflow.com/a/17936043> * Clone repo before PostgreSQL setup The PostgreSQL setup uses config files from the repo. * Fix PostgreSQL name in headings * Give PostgreSQL role login permissions Fixes an error upon running the first script: FATAL: role "kemal" is not permitted to log in * Remove nonexistent script * Use make for Invidious setup Copied from Linux section |
||
|---|---|---|
| .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