Markdown resource collection
29 Dec 2018 (last updated on 21 Sep 2020) - written by Hardy Scheel
Markdown
Markdown is a simple way to write, structure and format text. And all at the same time when you write the text.
Tutorials
- German: Markdown: Anleitung für die einfache Auszeichnungssprache
- German: Einführung, Syntax und Beispiele inkl. GitHub Flavoured Markdown
- interactive Markdown tutorial @markdowntutorial.com
- interactive Markdown tutorial @commonmark.org
Cheat Sheets
- Markdown syntax cheat sheet @github.com/adam-p
- Markdown reference quick overview @commonmark.org
- Markdown quick guide @github.com
Editors
Syntax highlighting in code blocks
Code blocks are part of the MarkDown specification but syntax highlighting is not. But many renderers like GitHub support syntax highlighting. Just open a code block and define your language or shell you want to colour.
- Look what languages are supported by syntax highlighting: https://highlightjs.org/static/demo/
Example usage:
```javascript
for (var i = 0 / 2; i < classes.length; i++) {
if (checkCondition(classes[i]) === undefined)
console.log('undefined');
}
```
LaTeX/Mathematics / TeX Mathematical Formulae
Some renderers can interpret LaTeX Mathematics. The beginning and ending dollar signs ($) are the delimiters for the TeX markup.
Examples:
$-b \pm \sqrt{b^2 - 4ac} \over 2a$
$x = a_0 + \frac{1}{a_1 + \frac{1}{a_2 + \frac{1}{a_3 + a_4}}}$
$\forall x \in X, \quad \exists y \leq \epsilon$
CommonMark
CommonMark is a propose for an unambiguous syntax reference specification for Markdown.