Skip to content

lobaro/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

Info / Warning / Question / Bug / ...

!!! info "Heading"

More text explaining in detail.

Another paragraph.

Instead of info you can use tip, success, question, warning, failure, danger, bug, example, quote. See Admonition.

Link to heading

### My Custom Heading{: #custom-id}

Go to Custom Heading

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:
squidfunk/mkdocs-material#693 (comment)

About

Public Documentation of Lobaro API's and Hardware (wiki)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published