https://github.com/tubearchivist/docs

All Tube Archivist Project Documentation
https://github.com/tubearchivist/docs

docs mkdocs mkdocs-material

Last synced: 5 days ago
JSON representation

All Tube Archivist Project Documentation

• Host: GitHub
• URL: https://github.com/tubearchivist/docs
• Owner: tubearchivist
• License: gpl-3.0
• Created: 2023-03-20T03:12:42.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-12-22T09:15:16.000Z (14 days ago)
• Last Synced: 2024-12-24T20:06:51.678Z (12 days ago)
• Topics: docs, mkdocs, mkdocs-material
• Language: CSS
• Homepage: https://docs.tubearchivist.com
• Size: 1.43 MB
• Stars: 54
• Watchers: 4
• Forks: 17
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Tube Archivist Documentation

## [docs.tubearchivist.com](https://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](https://github.com/tubearchivist/tubearchivist)

- The Website: [tubearchivist.com](https://www.tubearchivist.com/)

- The Discord: [tubearchivist.com/discord](https://www.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* direclty.

To setup a local development server:

Install requirements, e.g. with pip:

```

pip install -r requirements.txt

```

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/).

## Production environment

Build the Docker image:

```

docker build -t bbilly1/tubearchivist-docs .

```

Run the image:

```

docker run -p 80:80 bbilly1/tubearchivist-docs

```