Skip to content
Public Documentation of Lobaro API's and Hardware (wiki)
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
.drone.yml
.gitignore
README.md
deploykey
deploykey.pub
mkdocs.yml
requirements.txt

README.md

Documentation

This is the markdown source for the Lobaro online documentation. It is generated using mkdocs.

The generated documentation is available at https://docs.lobaro.com

Local Setup

Install Python: https://www.python.org/downloads/

Install Python dependencies (in this directory):

pip install -r requirements.txt

Run mkDocs

mkdocs serve

Features

For a feature description and general markdown information consult:

Extentions attr_list

Scaled images

![Alternative Text](url/to/img.png){: style="height:40px;width:143px"}`

URL open in new window

[URL Text](http://url.example/index.html){: target="_blank"}

For e.g. copyright information use: Footnotes

Legacy

For legacy online documentation see repo wiki.

Charts

This documentation uses MermaidJS to render flow charts etc. Charts are directly defined within the markdown source code and will be rendered in the client using JavaScript. The integration of mermaid into mkdocs is realised using the pymdown-extensions. Charts are defined in source code listings (with triple backticks ```) with the custom language mermaid defined. This solution is taken from a comment to an issue on github:
https://github.com/squidfunk/mkdocs-material/issues/693#issuecomment-411885426

You can’t perform that action at this time.