All Project Documentation
Go to file
2023-03-21 09:13:00 +07:00
mkdocs Update lists in FAQ 2023-03-20 14:07:10 -04:00
.gitignore deploy with docker nginx 2023-03-21 09:13:00 +07:00
Dockerfile deploy with docker nginx 2023-03-21 09:13:00 +07:00
LICENSE.md add LICENSE 2023-03-20 10:37:06 +07:00
README.md deploy with docker nginx 2023-03-21 09:13:00 +07:00
requirements.txt deploy with docker nginx 2023-03-21 09:13:00 +07:00

Tube Archivist Documentation

This is a work in progress, porting the old wiki to a more flexible documentation framework.

Development Environment

To just make simple changes, edit the markdown files within mkdocs/docs direclty.

To setup a local development server:

Install mkdocs with pip:

pip3 install mkdocs markdown-callouts mkdocs-material

From the AUR:

yay -S mkdocs markdown-callouts 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