Documentation template markdown - RWTH-EBC/AixLib GitHub Wiki

An alternative to writing your documentation in Dymola and possibly struggle with formatting and html is to write it in markdown. This can be done e.g. in Atom. You can enter markdown preview with ctrl+shift+m, then right-click, and "copy as html". This can then be pasted to Dymola or to the model code itself.

For this approach, here is our documentation template in markdown:

A short introduction.

#### Main equations

xxx

#### Assumptions and limitations

xxx

#### Typical use and important parameters

xxx

#### Options

xxx

#### Validation

Describe whether the validation was done using analytical validation, comparative model validation or empirical validation.
Implementation

xxx

#### References

xxx