All Project Documentation
Go to file
2023-09-25 12:13:49 +07:00
mkdocs add stats api docs 2023-09-04 17:47:24 +07:00
.gitignore ignore venv 2023-07-30 21:19:26 +07:00
Dockerfile bump python base 2023-07-30 23:15:20 +07:00
LICENSE.md add LICENSE 2023-03-20 10:37:06 +07:00
README.md update dev env with new deps 2023-04-01 19:19:41 +07:00
requirements.txt bump libraries 2023-09-25 12:13:49 +07:00

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:

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