Markdown is our preferred open-data format for the documentation (website), for writing papers and theses, managing knowledge, and creating slides. It is platform-independent, integrates well with git, and can easily be converted to other formats (e.g., PDF, HTML, DOCX) using Pandoc.
Each sentence should be in a new line (to ensure that the git diff is readable). To create a paragraph, add an empty line. This makes the history more readable and merging easier (see semantic line breaks).
Documentation
# Links that open in a separate window:
[name that displayed](https://website.com){: target="_blank"}
# References
<div class="references">
<p>Author, A. A. (Year). Title of work: Capital letter also for subtitle. Publisher.</p>
</div>
A very useful possibility is to include comments throughout the markdown document:
<!-- Comment can be used to add further explanations, links to references/resources, or to keep parts of the paper that were shortened -->
Papers are cited using the citation keys in the references.bib file and the citation syntax @Webster2002 or [@Webster2002]. Groups of in-text citations should be sorted alphabetically (especially if a prefix is used), i.e., use [e.g., @Bacharach1989; @Gregor2006a] instead of [e.g., @Gregor2006a; @Bacharach1989].
To ensure compatibility with pandoc word and latex conversion, figures should be included as jpg/png. For the final versions, vector graphics (PDF, EMF) should be included for Latex/Word respectively.
Formulas can be included as follows:
$$ P_i(x)=\sum_i a_i x^i $${#eq:eqn1}
Tables can be created with GridTables (which is displayed in PDF and Word documents):
+---------------------+----------+
| Property | Earth |
+=============+=======+==========+
| | min | -89.2 °C |
| Temperature +-------+----------+
| 1961-1990 | mean | 14 °C |
| +-------+----------+
| | max | 56.7 °C |
+-------------+-------+----------+
Table: Findings {#tbl:findings}
We show the findings in @tbl:findings.
<style scoped>
p {
padding-left: 36px;
text-indent: -36px;
}
</style>
# References
Weritz, P. (2022). Hey leaders, It’s time to train the workforce: Critical skills in the digital workplace. *Administrative Sciences*, 12(3), 94. doi: [10.3390/admsci12030094](https://doi.org/10.3390/admsci12030094){: target="_blank"}.
Exercise sheets
Jupyter notebooks are useful to create exercise sheets, combining Markdown with Python or R.