mirror of
https://github.com/tubearchivist/docs.git
synced 2025-07-12 12:08:16 +00:00
c9dfaaf7d8
A couple sections in the documentation erroneously refer to a subtitle related parameter needing to be an ISO 3166 country code, when they actually are supposed to be an ISO 639 language code.
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 directly.
To setup a local development server:
Install requirements, e.g. with pip:
pip install -r requirements.txt
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