Diese Datei wurde erzeugt mit

pandoc  -s -H styling.css -V lang=de --to=html5 --mathjax -f markdown+smart \
index.md -o index.html

Den “rohen” Markdown-Eingabetext findet man in index.md.

Die verwendete pandoc Version ist pandoc 2.2.3.2 (2018). Ältere Versionen sollte man meiden, z.B. kennt pandoc 1.16.0.2 (2015) viele Formatieranweisungen nicht.

Formatanweisungen

• Ein paar Format-Befehle

  • _abc_ *abc* → abc abc
  • **abc** → abc
  • `abc` → abc (Schreibmaschinenschrift für z.B. “inline code”)

• Ein fettes Wort kann man auch so schreiben: __fettes__.

• Item-Listen

  1. bla bla bla …

     • ad adf adf dsa fdf
     • adfwrev sev erv sev svf vf

  2. bla bla bla …

     • adf adsf sdf sd

     • af ewf ef erf

  • bla bla bla …

    • adfa sdfadsf adsf dsaf

      • adsfasds fsadaf

        printf("Hello World\n");

• Einrücken vom linken Rand

Die folgenden Zeilen sind am linken Rand ausgerichtet:

Zeile 1 Zeile 2 Zeile 3

Die folgenden Zeilen sind vier Zeichen vom linken Rand eingerückt:

Zeile 1
Zeile 2
Zeile 3

Die folgenden Zeilen sind sechs Zeichen vom linken Rand eingerückt:

  Zeile 1
  Zeile 2
  Zeile 3

Die folgenden Zeilen sind acht Zeichen vom linken Rand eingerückt:

    Zeile 1
    Zeile 2
    Zeile 3

• Definitionslisten

  Markdown

  Markup Sprache zum Schreiben von Texten

  Markdown-Extra

  Ein paar Erweiterungen, die später in Markdown kamen

• Unicode geht: 🤯

• Ein Link auf den Abschnitt “Verschiedenes”.

• Hier ist ein Zitat:

  Zeile 1
  Zeile 2

  Aufpassen: Wenn am Ende einer Zeile zwei oder mehr Leerzeichen sind, dann wird die Zeile umgebrochen. Die Zeile kann auch mit dem HTML Befehl </br> umgebrochen werden.

  Wenn die Leerzeichen nicht da sind, sieht es so aus:

  Zeile 1 Zeile 2

  Man kann auch eine sehr lange Zeile schreiben, die dann automatisch umgebrochen wird. Grundsätzlich ist das aber kein guter Stil, wenn man die .md Datei komfortabel im Editor lesen will.

  Hier ist ein langer langer langer langer langer langer langer langer langer langer langer langer langer langer langer langer langer langer langer langer langer langer langer langer langer langer Satz.

• Hier ist ein horizontaler Strich (drei Unterstriche: ___):

  ---

• In der README.md muss was stehen: Veranstaltung, Team, Teilnehmer, …

• Zu lange Zeilen bei fast allen .md Dateien. Automatischen Zeilenumbruch im Editor einstellen. Maximale Zeilenlaenge = 79 Zeichen.

• Einige Möglichkeiten von Markdown aufzeigen.

  Vorher: Es werden die Befehle wie touch, mv, cp zur Dateierzeugung und -bearbeitung benutzt.

  Nachher: Es werden die Befehle wie touch, mv, cp zur Dateierzeugung und -bearbeitung benutzt.

• Formeln:

  \[ E = m \times c^{2} \]

  \[ x = {-b \pm \sqrt{b^2-4ac} \over 2a} \]

• Tabellen

  2016	2017	2018
  35	42	57

• Links

  • http://www.python.org

  • Hier geht es zur Python Homepage

  • Hier geht es auch zur Python Homepage

• Hier ist ein Bild

  Den Text “Tux Logo” sieht man in einem Text-Browser, z.B. lynx. In einem grafischen Browser sieht man den Text “Tux ist das Linux Logo” wenn man mit der Maus über dem Bild steht.

  Jetzt eine Variante, auf die man auch klicken kann:

  

  Noch ein anderes Beispiel (man kann auf das Bild klicken):

  

• Sie sollten sich Ihre HTML-Ausgabe vorher selber ansehen.

• Pandoc Metadaten am Anfang der .md Datei:

  ---                                                                             
  title: Sysprog Übungen                                                           
  author: Hans Mustermann                                                               
  date: 14-02-2013                                                                
  ...             

• Ausgaben in Terminal-Schrift

  Beispiel: neofetch Ausgabe

            .-/+oossssoo+/-.               hhoegl@aspire
        `:+ssssssssssssssssss+:`           -------------
      -+ssssssssssssssssssyyssss+-         OS: Ubuntu 18.04.3 LTS x86_64
    .ossssssssssssssssssdMMMNysssso.       Host: Aspire E3-112 V1.10
   /ssssssssssshdmmNNmmyNMMMMhssssss/      Kernel: 5.0.0-29-generic
  +ssssssssshmydMMMMMMMNddddyssssssss+     Uptime: 12 days, 22 hours, 25 mins
 /sssssssshNMMMyhhyyyyhmNMMMNhssssssss/    Packages: 2052
.ssssssssdMMMNhsssssssssshNMMMdssssssss.   Shell: bash 4.4.20
+sssshhhyNMMNyssssssssssssyNMMMysssssss+   Resolution: 1366x768
ossyNMMMNyMMhsssssssssssssshmmmhssssssso   DE: Xfce
ossyNMMMNyMMhsssssssssssssshmmmhssssssso   WM: Xfwm4
+sssshhhyNMMNyssssssssssssyNMMMysssssss+   WM Theme: Default
.ssssssssdMMMNhsssssssssshNMMMdssssssss.   Theme: Greybird [GTK2/3]
 /sssssssshNMMMyhhyyyyhdNMMMNhssssssss/    Icons: Elementary-xfce-dark [GTK2], Elementary-xfce-d
  +sssssssssdmydMMMMMMMMddddyssssssss+     Terminal: xfce4-terminal
   /ssssssssssshdmNNNNmyNMMMMhssssss/      Terminal Font: DejaVu Sans Mono for Powerline 14
    .ossssssssssssssssssdMMMNysssso.       CPU: Intel Celeron N2940 (4) @ 2.249GHz
      -+sssssssssssssssssyyyssss+-         GPU: Intel Bay Trail
        `:+ssssssssssssssssss+:`           Memory: 1092MiB / 1876MiB
            .-/+oossssoo+/-.

• Syntaxeinfärbung

  GNU Assembler Syntax (verwende den “as” Stil)

  .section .data
  .section .text
  
  .globl _start
  
  _start:
      movl $1, %eax    # Nr. des Systemaufruf
      movl $12, %ebx   # Exit Code
      int $0x80        # Systemaufruf

  … und C Syntax

  int main()
  {
        printf("Hello World\n");
        return 0;
  }

• Abkürzungen

  *[HTML]: Hyper Text Markup Language

  In diesem Text sollte HTML ersetzt werden. Man muss jedoch in Pandoc die Erweiterung “abbreviations” aktivieren.

Style Sheets (CSS)

styling.css (https://benjam.info/panam)

wget http://b.enjam.info/panam/styling.css
pandoc -s --css=styling.css -V lang=de --to=html5 --mathjax -f markdown+smart input.md -o output.html

Mit -H kann man die CSS Datei in das erzeugte HTML-File inkudieren. Achtung: Die CSS Datei muss eingerahmt sein von <style type="text/css"> ... </style>.

pandoc --toc -s -H styling.css -V lang=de --to=html5 --mathjax -f markdown+smart index.md -o index.html

Die verwendeten Style-Sheets sind hier und hier.

Markup Editoren

1. Typora , 2. Visual Studio Code, 3. Atom, 4. Vim, 5. Haroopad, 6. Sublime Text 3, 7. Emacs, 8. ReText, 9. NeoVim, 10. Caret, 11. Remarkable, 12. Spacemacs, 13. GitBook Editor, 14. Abricotine, 15. Ghostwriter, 16. Uberwriter, 17. EME (Elegant Markdown Editor. https://eme.moe), 18. MarkMyWords, 19. LightMd Editor, 20. MindForger

aus: https://www.ubuntupit.com/best-markdown-editor-top-20-reviewed-for-linux-users

Verschiedenes

• Markdown Cheatsheet

  https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet

• Mehrere Dateien konvertieren:

  https://stackoverflow.com/questions/40993488/convert-markdown-links-to-html-with-pandoc

  Zum Beispiel kann man das pandocflute Paket (Python) verwenden.

  # checks every link element and if the url ends with .md 
  # replaces it with .html.
  import panflute as pf
  
  def action(elem, doc):
    if isinstance(elem, pf.Link) and elem.url.endswith('.md'):
        elem.url = elem.url[:-3] + '.html'
        return elem
  
  if __name__ == '__main__':
    pf.run_filter(action)

• Alternativen zu Markdown: Textile (https://textile-lang.com),
  Restructured Text (http://docutils.sourceforge.net/rst.html), asciidoc (http://asciidoc.org), Markdeep (https://casual-effects.com/markdeep).

  Anstatt Pandoc kann man auch Python-Markdown verwenden (https://python-markdown.github.io).