Torrust Documentation

This is the documentation site for the Torrust Tracker and Index.

Live: https://torrust.com/

Installation

Prerequisites:

• Python
• pip
• MkDocs
• MkDocs Material theme

You can install mkdocs and mkdocs-material with:

pip3 install mkdocs
pip3 install mkdocs-material

Install:

git clone https://github.com/torrust/torrust-documentation.git

Usage

Run for development:

Navigate to the project folder (docs) and run the following command:

mkdocs serve

Visit http://localhost:8000 to see live changes.

Run for production:

Navigate to the project folder (docs) and build the static site:

mkdocs build

Publish the newly built docs/site folder using NGINX or Apache.

Contributing

Please report any bugs you find to our issue tracker. Ideas and feature requests are welcome as well! Any pull request targeting existing issues would be very much appreciated.