Skip to content
The bt-trx manual
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
custom_theme/img Add favicon Jun 4, 2019
docs Troubleshooting und Kompatibilitätsliste aktualisiert Jan 29, 2020
.gitignore add site/ folder Oct 29, 2019
LICENSE Added CC-BY-SA 4.0 license May 8, 2019
README.md Add info and template for PDF generation Nov 28, 2019
mkdocs.yml

README.md

bt-trx Manual

This manual is mkdocs based.

Install mkdocs, mtdocs material and rtd-dropdown theme

python -m pip install mkdocs
python -m pip install mkdocs-material
python -m pip install mkdocs-pdf-export-plugin

Important: Each file name needs to be the same as the first heading in each file.

View documentation locally

mkdocs serve

This command starts a local webserver at localhost:8000.

Build static documentation files (HTML)

mkdocs build

This command builds the documentation in ./site/

Deploy to Github Pages

mkdocs gh-deploy

Will build the static files and push to the gh-pages branch on Github, so they will be served automatically at manual.bt-trx.com

Generate PDF

Currently, the mkdocs-pdf-export-plugin can't handle anchors, therefore it is necessary to temporarily alter links containing anchors i.e. from "(../PTT-Taste#soft-ptt)" to "(../PTT-Taste.md#soft-ptt)" to be able to generate a PDF file.

export ENABLE_PDF_EXPORT=1
mkdocs build
You can’t perform that action at this time.