Markdown Syntax

Zuletzt aktualisiert am 17. Januar 2024 5 Minuten

Kurze nicht vollständige Zusammenfassung als Reminder:

Überschriften

Mit 1 bis 6 # am Anfang der Zeile für H1 bis H6:

# H1 Überschrift
## H2 Überschrift
### H3 Überschrift
#### H4 Überschrift
##### H5 Überschrift
###### H6 Überschrift

Betonung

Markdown-Cheatsheetexternal link

*Kursiv* oder _Kursiv_
Kombiniert: **Sternchen und _Unterstrich_**
~~Durchgestrichen~~

Listen

Markdown-Cheatsheetexternal link

Führende und nachfolgende Leerzeichen stelle ich der Übersicht halber mit Punkten ⋅⋅⋅ dar. Jeder Punkt steht für ein Leerzeichen.

1. Erster nummerierter Listenpunkt
1. Ein weiterer Punkt
    - Eingerückte Unordered Sub-Liste
  • * Unordered List kann Sternchen verwenden
  • - oder Minus
  • + oder Plus

Absätze / Zeilenümbrüche

Eingerückte Absätze innerhalb der Listenelemente. Beachte die führenden Leerzeichen: Mindestens eins, am besten drei.

Mit dieser Zeile beginnt dieser Text.

Diese Zeile ist von der obigen durch zwei Zeilenumbrüche getrennt, sie ist also ein *getrennter Absatz*.

Diese Zeile ist auch ein separater Absatz, aber...
Diese Zeile ist nur durch einen einzigen Zeilenumbruch getrennt, also ist sie eine eigene Zeile im *gleichen Absatz*.

Mit dieser Zeile beginnt dieser Text.

Diese Zeile ist von der obigen durch zwei Zeilenumbrüche getrennt, sie ist also ein getrennter Absatz.

Diese Zeile ist auch ein separater Absatz, aber… Diese Zeile ist nur durch einen einzigen Zeilenumbruch getrennt, also ist sie eine eigene Zeile im gleichen Absatz.

Markdown-Cheatsheetexternal link

Es gibt zwei Möglichkeiten, Links zu erstellen:

[Linktext](https://)
[Linktext](https:// "mit Linktitel als Tooltip")
[ ][referenz_1]

[referenz_1]: https://

URLs und URLs in spitzen Klammern werden automatisch in Links umgewandelt:

http://www.example.com
example.com
<example.com>

In der Form http://www.example.comauf jeden Fall, und manchmal auch in der Form: example.com

Bilder

Markdown-Cheatsheetexternal link

![alt text](https:// "Beschriftung")

Code and Syntax Highlighting

Markdown-Cheatsheetexternal link

Beispiel 1:

Inline `code` innerhalb einer Zeile mit `back-ticks` drumherum

Inline code innerhalb einer Zeile mit back-ticks drumherum

Beispiel 2:

```
hier steht der Code
```
  • Drei Backticks: ```

  • Keine Sprache angegeben, also kein Syntax-Highlighting.

  • Beispiel 3:

```javascript
- var s = "JavaScript syntax highlighting";
- alert(s);
```
  • Beispiel 4:
- ```python
- s = "Python syntax highlighting"
- print s
- ```

CodeBlock - Unterstütze Sprachen

  • Cucumber (’*.feature')
  • abap (’*.abap')
  • ada (’.adb’, ‘.ads’, ‘*.ada’)
  • ahk (’.ahk’, ‘.ahkl’)
  • apacheconf (’.htaccess’, ‘apache.conf’, ‘apache2.conf’)
  • applescript (’*.applescript’)
  • as (’*.as’)
  • as3 (’*.as')
  • asy (’*.asy')
  • bash (’.sh’, ‘.ksh’, ‘.bash’, ‘.ebuild’, ‘*.eclass’)
  • bat (’.bat’, ‘.cmd’)
  • befunge (’*.befunge’)
  • blitzmax (’*.bmx’)
  • boo (’*.boo’)
  • brainfuck (’.bf’, ‘.b’)
  • c (’.c’, ‘.h’)
  • cfm (’.cfm’, ‘.cfml’, ‘*.cfc’)
  • cheetah (’.tmpl’, ‘.spt’)
  • cl (’.cl’, ‘.lisp’, ‘*.el’)
  • clojure (’.clj’, ‘.cljs’)
  • cmake (’*.cmake’, ‘CMakeLists.txt’)
  • coffeescript (’*.coffee’)
  • console (’*.sh-session’)
  • control (‘control’)
  • cpp (’.cpp’, ‘.hpp’, ‘.c++’, ‘.h++’, ‘.cc’, ‘.hh’, ‘.cxx’, ‘.hxx’, ‘*.pde’)
  • csharp (’*.cs’)
  • css (’*.css’)
  • cython (’.pyx’, ‘.pxd’, ‘*.pxi’)
  • d (’.d’, ‘.di’)
  • delphi (’*.pas’)
  • diff (’.diff’, ‘.patch’)
  • dpatch (’.dpatch’, ‘.darcspatch’)
  • duel (’.duel’, ‘.jbst’)
  • dylan (’.dylan’, ‘.dyl’)
  • erb (’*.erb’)
  • erl (’*.erl-sh’)
  • erlang (’.erl’, ‘.hrl’)
  • evoque (’*.evoque’)
  • factor (’*.factor’)
  • felix (’.flx’, ‘.flxh’)
  • fortran (’.f’, ‘.f90’)
  • gas (’.s’, ‘.S’)
  • genshi (’*.kid’)
  • glsl (’.vert’, ‘.frag’, ‘*.geo’)
  • gnuplot (’.plot’, ‘.plt’)
  • go (’*.go’)
  • groff (’.(1234567)’, ‘.man’)
  • haml (’*.haml')
  • haskell (’*.hs')
  • html (’.html’, ‘.htm’, ‘.xhtml’, ‘.xslt’)
  • hx (’*.hx’)
  • hybris (’.hy’, ‘.hyb’)
  • ini (’.ini’, ‘.cfg’)
  • io (’*.io’)
  • ioke (’*.ik')
  • irc (’*.weechatlog')
  • jade (’*.jade')
  • java (’*.java')
  • js (’*.js')
  • jsp (’*.jsp')
  • lhs (’*.lhs')
  • llvm (’*.ll')
  • logtalk (’*.lgt')
  • lua (’.lua’, ‘.wlua’)
  • make (’.mak’, ‘Makefile’, ‘makefile’, ‘Makefile.’, ‘GNUmakefile’)
  • mako (’*.mao’)
  • maql (’*.maql’)
  • mason (’.mhtml’, ‘.mc’, ‘*.mi’, ‘autohandler’, ‘dhandler’)
  • markdown (’*.md’)
  • modelica (’*.mo’)
  • modula2 (’.def’, ‘.mod’)
  • moocode (’*.moo’)
  • mupad (’*.mu’)
  • mxml (’*.mxml')
  • myghty (’*.myt’, ‘autodelegate’)
  • nasm (’.asm’, ‘.ASM’)
  • newspeak (’*.ns2')
  • objdump (’*.objdump')
  • objectivec (’*.m')
  • objectivej (’*.j')
  • ocaml (’.ml’, ‘.mli’, ‘.mll’, ‘.mly’)
  • ooc (’*.ooc’)
  • perl (’.pl’, ‘.pm’)
  • php (’.php’, ‘.php(345)’)
  • postscript (’.ps’, ‘.eps’)
  • pot (’.pot’, ‘.po’)
  • pov (’.pov’, ‘.inc’)
  • prolog (’.prolog’, ‘.pro’, ‘*.pl’)
  • properties (’*.properties’)
  • protobuf (’*.proto’)
  • py3tb (’*.py3tb')
  • pytb (’*.pytb')
  • python (’.py’, ‘.pyw’, ‘.sc’, ‘SConstruct’, ‘SConscript’, ‘.tac’)
  • r (’*.R’)
  • rb (’.rb’, ‘.rbw’, ‘Rakefile’, ‘.rake’, ‘.gemspec’, ‘.rbx’, ‘.duby’)
  • rconsole (’*.Rout’)
  • rebol (’.r’, ‘.r3’)
  • redcode (’*.cw’)
  • rhtml (’*.rhtml’)
  • rst (’.rst’, ‘.rest’)
  • sass (’*.sass’)
  • scala (’*.scala’)
  • scaml (’*.scaml’)
  • scheme (’*.scm’)
  • scss (’*.scss’)
  • smalltalk (’*.st')
  • smarty (’*.tpl')
  • sourceslist (‘sources.list’)
  • splus (’.S’, ‘.R’)
  • sql (’*.sql')
  • sqlite3 (’*.sqlite3-console')
  • squidconf (‘squid.conf’)
  • ssp (’*.ssp')
  • tcl (’*.tcl')
  • tcsh (’.tcsh’, ‘.csh’)
  • tex (’.tex’, ‘.aux’, ‘*.toc’)
  • text (’*.txt’)
  • v (’.v’, ‘.sv’)
  • vala (’.vala’, ‘.vapi’)
  • vbnet (’.vb’, ‘.bas’)
  • velocity (’.vm’, ‘.fhtml’)
  • vim (’*.vim’, ‘.vimrc’)
  • xml (’.xml’, ‘.xsl’, ‘.rss’, ‘.xslt’, ‘.xsd’, ‘.wsdl’)
  • xquery (’.xqy’, ‘.xquery’)
  • xslt (’.xsl’, ‘.xslt’)
  • yaml (’.yaml’, ‘.yml’)

Blockzitate

Markdown-Cheatsheetexternal link

  • > Blockzitate sind in E-Mails sehr praktisch, um Antworttexte zu emulieren.

  • > Diese Zeile ist Teil desselben Zitats.

  • Dieser Text trennt die Zitate

  • > Mann kann **Markdown** in ein Blockzitat **schreiben**. Das ist ein Langes Zitat: Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus.

Horizontale Linie

Markdown-Cheatsheetexternal link

Ensteht durch drei oder mehr Bindestriche ---, Sternchen *** , oder Unterstriche ___

---
***
___

Zeilenumbrüche

  • Einmal return drücken (d.h. einen Zeilenumbruch einfügen)
  • Zweimal return drücken: Einen Absatz einfügen
  • Einige Varianten:

Hier ist ein Satz.

Diese Zeile wird durch zwei Zeilenumbrüche von der obigen Zeile getrennt, so dass ein separater Absatz entsteht.

Diese Zeile ist auch ein eigener Absatz, aber… Diese Zeile ist nur durch einen einzigen Zeilenumbruch getrennt, es handelt sich also um eine separate Zeile im gleichen Absatz.