mirror of
https://github.com/tubearchivist/docs.git
synced 2024-12-22 18:00:15 +00:00
All Project Documentation
2287ca69f4
* Update advanced.md: Bulk clear errors on download queue * clarify where to run this from --------- Co-authored-by: Simon <simobilleter@gmail.com> |
||
|---|---|---|
| mkdocs | ||
| .gitignore | ||
| Dockerfile | ||
| LICENSE.md | ||
| README.md | ||
| requirements.txt | ||
Tube Archivist Documentation
docs.tubearchivist.com
This is the git repo of the official documentation for Tube Archivist - Your self hosted YouTube media server.
Additional links:
- The Project: tubearchivist/tubearchivist
- The Website: tubearchivist.com
- The Discord: tubearchivist.com/discord
Make Changes
Please help improve these documentations. To make changes, fork this repo and make your changes. When you are ready, open a Pull Request. When merged, this will rebuild the live documentations within a few seconds.
Development Environment
To just make simple changes, edit the markdown files within mkdocs/docs direclty.
To setup a local development server:
Install requirements with pip:
pip3 install -r requirements.txt
For Arch:
pacman -S python-cairosvg python-pillow
yay -S mkdocs mkdocs-material
More details: User Guide
Run the server from the mkdocs folder with:
mkdocs serve
And the site - with live reload enabled - should be available on localhost:8000.
Production environment
Build the Docker image:
docker build -t bbilly1/tubearchivist-docs .
Run the image:
docker run -p 80:80 bbilly1/tubearchivist-docs