Einführung in Markdown und Beispiele für dessen Anwendungsbereiche
Creators: name: Pietsch, Andre M.
Publisher: name: Zenodo
Year: 2023
Subjects: Programmierung
Auszeichnungssprache
Markdown
Dokumentation
Code-Dokumentation
Softwareentwicklung
programming
coding
markup language
documentation
code documentation
software
software engineering

description: <strong>Abstract: </strong><br> <br> Der Vortrag soll einen ersten Einblick in die einfache, aber sehr universell nutzbare Auszeichnungssprache Markdown geben. Sie hat zwar auf den ersten Blick nur sehr peripher mit dem Thema Coding zu tun, wird aber an vielen Stellen für die Code-Dokumentation genutzt und kann beispielsweise in Verbindung mit dem Markdown-basierten Diagramm- und Charting-Tool Mermaid auch dazu genutzt werden, um Planungsprozesse in reinen Textdateien zu skizzieren. Außerdem werden Markdown-Kenntnisse in Tools wie GitLab oder JupyterNotebooks vorausgesetzt bzw. findet dort häufig Verwendung, weshalb ein Überblick über diese einfache Auszeichnungssprache und ihre Anwendungsbereiche für die spätere Beschäftigung mit dem eigentlichen Code nützlich sein kann. <strong>Anmerkungen zu den Folien bzw. zum Datensatz:</strong> <em>[An English version of these informations and instructions can be found in the readme.md file inside the file archive]</em><br> <br> Falls Sie nur an den Präsentationsinhalten selbst interessiert sein sollten, finden Sie hier die PDF- und PPTX-Datei des Vortrags.<br> <br> Falls Sie sich das Markdown-Format genauer anschauen oder es ausprobieren möchten, finden Sie hier weitere relevante Dateien, darunter auch die Ursprungsdatei der obigen Vortragsfolien - eine Markdown-Datei mit dem Namen "hefdi-data-week_markdown_pietsch_20230615.md", die mit dem Framework "Marp" erstellt wurde. Aus dieser wurden die "*.html", "*.pdf" und "*.pptx" erzeugt. Der Export bringt folgende Probleme mit sich: <strong>*.pptx</strong>: Eine mit "Marp" erzeugte *.pptx erstellt PowerPoint-Folien lediglich als Bilder. Integrierte, normalerweise auch klickbare Links sind zwar dann immer noch hellblau bzw. mit der Farbe des Links hinterlegt, können aber nicht mehr angeklickt werden. <strong>*.pdf</strong>: In der *.pdf-Version ist die Darstellung des Mermaid-Diagramms (Folie 27) fehlerhaft. <strong>*.html</strong>: Hier kommt es zu Problemen bei der Darstellung der Bilder, da diese praktisch live über den Pfad, wo sich die Bilder befinden, sprich dem Ordner "bilder", erzeugt werden. Einerseits können bestimmte Bilder und der Hintergrund nicht dargestellt werden, da sie aufgrund einer nicht offenen Lizenz entfernt werden mussten. Andererseits kommt es in manchen Fällen zu Problemen bei der relativen Pfadangabe, sodass auch die anderen Bilder nicht angezeigt werden. Ein Grund dafür könnte ein unterschiedliches Betriebssystem sein (z.B. Linux), da die Folien auf einem Windows-Rechner in das "*.html"-Format exportiert worden sind. Sie können die ursprüngliche Markdown-Datei allerdings als Vorlage nutzen, um ihre eigenen Bilder und Texte und somit ihre eigenen Folien in verschiedenen Formaten zu erzeugen. Dazu hier eine kurze Anleitung, wie Sie "Marp" verwenden können: 1. Installieren Sie zuerst den Quelltext-Editor "Visual Studio Code" über den folgenden Link: https://code.visualstudio.com/ 2. Öffnen Sie "Visual Studio Code" (nutzen Sie am besten die englische Version) und klicken Sie "Strg"+"Shift"+"X" oder klicken Sie links auf "Extensions". 3. Geben Sie in das Suchfeld "Marp for VS Code" ein uns installieren Sie die Erweiterung. 4. Nun können Sie mit "Strg"+"Shift"+"E" oder einem Klick auf "Explorer" zu den Dateien zurückkehren und die Markdown-Datei anklicken. 5. Um nun eine Side-by-Side-Preview in "Visual Studio Code" zu erzeugen, klicken Sie zuerst "Strg"+"K", um in den Shortcut-Modus zu gelangen und klicken Sie dann (ohne "Strg"+"K" weiter gedrückt zu halten) die Taste "V". In der Side-by-Side-Preview können Sie nun live sehen, welche Änderungen Sie durch die Änderung der Markdown-Datei erzeugen. 6. Wenn Sie mit der Bearbeitung der Folien fertig sind, können Sie die Markdown-Datei nun in ein anderes Format exportieren. Hier bietet sich vor allem "*.html" an. Dafür klicken Sie, während Sie sich in der Markdown-Datei befinden auf die zwei sich überlappenden Dreiecke oben rechts ("Show Quick Pick of Marp Commands"). In dem dann erscheinenden Dropdown-Menü klicken Sie auf "Export Slide Deck..." und wählen nun das Format für die Folien aus.<br> <strong>Information zur HeFDI Data Week:</strong> Die dreitägige HeFDI Data Week ermöglicht es Forschenden, Lehrenden und allen weiteren Interessierten, Themen und Angebote des Forschungsdatenmanagements kennenzulernen und zu erproben. Darüber hinaus werden den Teilnehmenden Daten- und Coding-Kompetenzen vermittelt sowie Dienste und Angebote verschiedener hessischer Infrastruktur-Einrichtungen und Zentren vorgestellt.
description: Die HeFDI Data Week ist ein Angebot der Landesinitiative HeFDI - Hessische Forschungsdateninfrastrukturen, welche vom Hessischen Ministerium für Wissenschaft und Kunst (HMWK) finanziert wird.