All Project Documentation
Go to file
Simon fc18ddf19d
add LICENSE
2023-03-20 10:37:06 +07:00
mkdocs add basic project structure 2023-03-20 10:35:17 +07:00
LICENSE.md add LICENSE 2023-03-20 10:37:06 +07:00
README.md add dev environment instructions 2023-03-20 10:35:43 +07:00

README.md

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:

pip install mkdocs

From the AUR:

yay -S mkdocs

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.