# Reader ## Kollaborative Erstellung eines Readers mit HackMD – Markdown für Einsteiger [Felix Lohmeier](https://felixlohmeier.de) (Open Culture Consulting) [OERcamp 2019 Lübeck](https://www.oercamp.de/19/lubeck/), 13./14. Juni 2019 note: Das ist meine Notiz --- ![OERcamp Lübeck 2019](https://www.oercamp.de/wp-content/uploads/2019/04/OERcamp-Lu%CC%88beck-Anmeldung-1024x572.jpg) --- ## Abstract * Das Markdown-Format ist lesbar, für das Web gemacht und kann gut in verschiedene Ausgabeformen (PDF, HTML, ODF, DOCX, EPUB) konvertiert werden. * Wir erproben in diesem Workshop gemeinsam die Möglichkeiten der Erstellung von Readern mit Markdown am Beispiel der Plattform https://hackmd.io. * Siehe auch [Teil 2: Präsentationsfolien erstellen und kollaborativ bearbeiten mit HackMD](https://pad.gwdg.de/p/5q4hYet_D#/) --- ## Anforderungen an Reader * Online und Print (HTML, PDF, EPUB) * Mehrere Texte in übersichtlicher Struktur * kollaborative Erstellung (Änderungskontrolle, gleichzeitige Bearbeitung) --- ## Warum Markdown? * in jedem Texteditor lesbar * Formatierung reduziert auf das Wesentliche * funktioniert gut mit Versionskontrolle (Änderungen über automatisches diff nachvollziehbar, weil Textformat) * für das Web gemacht, Basis für zahlreiche Tools und Workflows * lässt sich gut in verschiedene Ausgabeformen (HTML, PDF, DOCX, ODT, EPUB usw.) konvertieren --- ## Einführung in Markdown | Markdown | Darstellung | | -------- | -------- | | `# Überschrift 1` | Überschrift 1 | | `## Überschrift 2` | Überschrift 2 | | `**fett**` | **fett** | | `*kursiv*` | *kursiv* | | `[Markdownguide](http://www.markdownguide.org)` | [Markdownguide](http://www.markdownguide.org) | Mehr: https://www.markdownguide.org/cheat-sheet --- ## Übung: Markdown Tutorial http://markdowntutorial.com --- ## HackMD vs. CodiMD * HackMD [hat 2017 eine separate Enterprise Version veröffentlicht](https://hackmd.io/c/community-news/https%3A%2F%2Fhackmd.io%2Fs%2FBk-zpEC9-) * HackMD community edition [wurde 2018 mit v1.2.0 in CodiMD umbenannt](https://github.com/hackmdio/hackmd/issues/720) ```mermaid graph LR HackMD(HackMD) -->|closed source| HackMDcode[fa:fa-code HackMD.io code] HackMDcode -->|free/guest| HackMDio[fa:fa-home hackmd.io] HackMDcode -->|pay/request| HackMDee[fa:fa-home hackmd.io enterprise] HackMD -->|open source| CodiMDcode[fa:fa-code CodiMD code] CodiMDcode -->|free/guest| okfn[fa:fa-home hackmd.okfn.de] CodiMDcode -->|free/register| gwdg[fa:fa-home pad.gwdg.de] CodiMDcode -->|free/register| cern[fa:fa-home codimd.web.cern.ch] ``` --- ## Features HackMD vs. CodiMD | Funktion | CodiMD | Hackmd.io | demo.hackmd.io | | ---------- | ------------------ | ------------------ | ------------------ | | [Book Mode](https://hackmd.io/book-example) | :x: | :x: | :white_check_mark: | | [Slide Mode](https://hackmd.io/slide-example) | :white_check_mark: | :x: | :white_check_mark: | | [Templates](https://hackmd.io/c/news/%2Fs%2Fr13SRPOYV) | :x: | :white_check_mark: | :x: | | Export | + PDF | + ODF | + ODF | --- ## Übung: Gemeinsamen Reader zum OERcamp erstellen Link zum gemeinsamen Dokument in der CodiMD-Installation der GWDG: Do, 13.6.: https://pad.gwdg.de/s/b9hnlweUz/edit Fr, 14.6.: https://pad.gwdg.de/s/H1condEsq/edit --- ## Markdown vielseitig verwendbar * Mit CodiMD Export in HTML oder PDF möglich * [Pandoc](https://pandoc.org) konvertiert zusätzlich in DOCX, ODT, LaTeX, EPUB, usw. * Diverse Markdown-Editoren für Windows, macOS und Linux. Empfehlung: [Typora](https://typora.io) * Online-Plattformen sind nicht so beständig, daher die Markdown-Dateien in einem Git-Repository und das Ergebnis als PDF in einem Repository veröffentlichen? --- ## Übung: Pandoc Live https://pandoc.org/try/ Für Konvertierung zu DOCX, ODT, EPUB usw. muss die Software installiert werden. --- ## Alternativen zu HackMD/CodiMD für Reader * Für kleinere Texte: [Gists](https://gist.github.com) * `README.md` in Git-Repos bei [GitHub](https://help.github.com/en/articles/about-writing-and-formatting-on-github)/[GitLab](https://about.gitlab.com/2018/08/17/gitlab-markdown-tutorial/) * [Gitbook](https://www.gitbook.com) (mittlerweile kostenpflichtig, unklar wie lange https://legacy.gitbook.com noch läuft) * [LeanPub](https://leanpub.com) (generiert HTML, PDF und EPUB) * [Bookdown.org](https://www.rstudio.com) (mit RStudio) --- ## Credits / Lizenz Die Folien wurden erstellt mit [CodiMD](https://github.com/hackmdio/codimd) (AGPL 3.0). Für die Präsentation verwendet CodiMD u.a. [Reveal.js](https://github.com/hakimel/reveal.js) (MIT) und [Mermaid](https://github.com/knsv/mermaid) (MIT). Eigenes: Dieses Werk ist lizenziert unter einer [Creative Commons Namensnennung 4.0 International Lizenz](http://creativecommons.org/licenses/by/4.0/). ![CC BY 4.0](https://i.creativecommons.org/l/by/4.0/88x31.png)
{"type":"slide","slideOptions":{"transition":"slide"}}