docs/README.md

41 lines
864 B
Markdown
Raw Normal View History

2023-03-20 03:14:15 +00:00
# Tube Archivist Documentation
This is a work in progress, porting the old wiki to a more flexible documentation framework.
2023-03-20 03:35:43 +00:00
## 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
2023-03-20 03:35:43 +00:00
```
From the AUR:
```
yay -S mkdocs markdown-callouts mkdocs-material
2023-03-20 03:35:43 +00:00
```
More details: [User Guide](https://www.mkdocs.org/user-guide/installation/)
Run the server from the *mkdocs* folder with:
```
mkdocs serve
```
And the site - with live reload enabled - should be available on [localhost:8000](http://localhost:8000/).
2023-03-21 02:13:00 +00:00
## Production environment
Build the Docker image:
```
docker build -t bbilly1/tubearchivist-docs .
```
Run the image:
```
docker run -p 80:80 bbilly1/tubearchivist-docs
```