Markdown-Dokumente in docx-Dokumente umwandeln

Markdown

Weshalb es an der Zeit ist Markdown zu lernen? habe ich beschrieben, weshalb es sinnvoll sein kann "Markdown" zu lernen. Die leicht zu erlernende Auszeichnungssprache bietet eine sehr große Felxibilität zum Erstellen von Dokumenten.

Die mit Markdown erstellten Dokumente lassen sich mit "Pandoc" in andere Formate, wie das von Microsoft Word verwendete Format docx konvertieren.

In meinem früheren eitrag Git und Word – Versionsvergleich von docx-Dateien habe ich bereits einmal über Pandoc geschrieben. In dem Artikel ging es um den Vergleich von docx-Dateien, die in Git verwaltet werden.


Gib mir gerne einen Kaffee ☕ aus!

Wenn dir meine Beiträge gefallen und geholfen haben, dann kannst du mir gerne einen Kaffee ☕ ausgeben.

PayPal Logo


liberapay.com/strobelstefan.org


Kaffee via Bitcoin

bc1qfuz93hw2fhdvfuxf6mlxlk8zdadvnktppkzqzj


Pandoc gibt es für alle gängigen Betriebssystem. Die Installation des Programms, wie in meinem Beitrag beschrieben, ist unter Windows kinderleicht und damit lassen sich "Markdown"-Dateien sehr einfach in das docx-Format konvertieren.

Möchtet ihr Pandoc zuerst einmal ausprobieren, dann gibt es auf der offiziellen Website des Projekts die Möglichkeit des Testens https://pandoc.org/try

Eine Konvertierung nach PDF ist nicht möglich. Beim Versuch wir die Fehlermeldung

"pdflatex not found. Please select a different –pdf-engine or install pdflatex" ausgeben.

Unter Windows finde ich die Installation von "pdflatex" ein wenig umständlich, deshalb gehe ich hier nicht weiter darauf ein. Einfacher gestaltet sich die Verwendung unter einem Linux.

Die Grundsätzliche Syntax von "Pandoc" ist wie folgt.

pandoc <ausgangsdatei> -f <ausgangsformat> -t <zielformat> -o <zieldatei>

An einem Beispiel wird das Konvertieren in das "docx"-Format etwas anschaulicher.

Öffnet die *"Eingabeaufforderung" oder die "Git Bash". Dann hangelt ihr euch zu dem Ordner, wo die Markdown-Datei zu finden ist. Anschließend führt ihr einfach den Konvertierungsbefehl aus.

Als Beispiel-Datei verwende ich meinem Markdown-Spickzettel, den ihr hier herunterladen könnt. ➡ https://codeberg.org/strobelstefan.org/Markdown

Die Dateiendung habe ich einmal in ".txt" umbenannt und einmal habe ich den Dateinamen bei ".md" belassen

pandoc Markdown-Spickzettel.txt -f markdown -t docx -o Markdown-Spickzettel-aus-txt.docx
pandoc Markdown-Spickzettel.md -f markdown -t docx -o Markdown-Spickzettel-aus-md.docx

Eine vollständige Liste alle Pandoc-Befehle gibt es auf der offiziellen Website des Projekts https://pandoc.org/demos.html

Markdown-Spickzettel zum herunterladen

Markdown

Hier im Blog habe ich bereits einige Artikel über „Git“ geschrieben. Wenn man sich mehr und mehr mit der Materie beschäftigt, stößt man irgendwann mal an den Punkt, wo es um die Datei „README.md“ geht. Und dann folgt auch schon der nächste Schritt mit „Markdown„, die Formatierung der „Liesmich„-Datei.

Auf Github, GitLab, Bitbucket, etc. wird für jedes Projekt eine README.md angelegt, um das Projekt zu beschreiben.

Der Inhalt ist über den Webbrowser anzusehen und auch immer schön formatiert. Das liegt eben daran, dass der Ersteller den Inhalt mit Markdown geschrieben hat.

Was ist Markdown?

Markdown eine für Menschen leicht verständliche Auszeichnungssprache.

Dateiendung für Markdown

Die Dateiendung „.md“, in manchen Fällen auch „.markdown“, steht für „Markdown Documentation“. Diese Bezeichnung weist darauf hin, dass jedes .md-File in einer der verfügbaren Dialekte der Markdown-Entwicklungssprachen geschrieben ist. Diese zählen zu den Markup- bzw. Auszeichnungssprachen.

Editoren

Die meisten gängigen Editoren lassen sich mit ein paar Handgriffen so anpassen, dass Markdown angezeigt werden kann.

Notepad++

Es wird für den beliebten Editor Notepad++ eine Erweiterung angeboten, die sich über die „Plugin-Verwaltung“ sehr einfach installieren lässt.

Erweiterungen --> Plugin-Verwaltung

Dort sucht man nach dem Plugin „MarkdownViewer++“ und installiert es.

Annschließend lassen sich die Markdown-Dateien in der Vorschau ausgeben.
Die Vorschau wird mit der Tastenkombination Strg + Shift + M aktiviert.

Notepad++ - Markdown
Notepad++ – Markdown

Gib mir gerne einen Kaffee ☕ aus!

Wenn dir meine Beiträge gefallen und geholfen haben, dann kannst du mir gerne einen Kaffee ☕ ausgeben.

PayPal Logo


liberapay.com/strobelstefan.org


Kaffee via Bitcoin

bc1qfuz93hw2fhdvfuxf6mlxlk8zdadvnktppkzqzj


Atom Editor

Für den Atom Editor habe ich die folgenden Erweiterungen für Markdown installiert.

  • language-markdown
  • markdown-writer

In den Core Packages von Atom ist bereits ein Plugin für die „Markdown Preview“ enthalten.
Die Vorschau lässt sich wie bei Notepad++ mit der Tastenkombination Strg + Shift + M aktivieren.

Atom - Markdown
Atom – Markdown

Bei den Editoren „Notepad++“ und „Atom“ kann es evtl. zu Problemen in der Preview kommen, wenn man Links setzt. Hier bietet sich ein relativ unkomplizierter Workaround an. Anstatt die Preview in den Editoren anzeigen zu lassen, kann die Anzeige auch in einem Webbrowser erfolgen. Für die Anzeige ist eine Erweiterung zu installieren.

Chrome Browser, Brave Browser, Edge, …

Markdown Viewer
Markdown Viewer
Entwickler: simov.github.io
Preis: Kostenlos

Mozilla Firefox

Markdown Viewer Webext
Markdown Viewer Webext
Entwickler: Cimbali
Preis: Kostenlos

Joplin

Ein guter Markdown-Editor ist Joplin.
Ich habe den Editor bereits in meinem Blog vorgestellt.
Nextcloud – Notizen mit unterschiedlichen Endgeräten bearbeiten

Der Editor eigenet sich hervorragend für die Speicherung von Notizen auf Cloud-Diensten, wie z.B. Nextcloud.

Ich verwende Joplin auf sämtlichen meiner Endgeräte um sehr einfach und schnell Notizen auf meine eigene Nextcloud zu speichern.

Apple App Store

‎Joplin
‎Joplin
Entwickler: Laurent Cozic
Preis: Kostenlos

Google Play Store

Joplin
Joplin
Entwickler: Laurent Cozic
Preis: Kostenlos

Offizielle Website
https://joplinapp.org/

WordPress

Und natürlich nicht zu vergessen, WordPress selbst unterstützt seit „Gutenberg“ auch Markdown.

Allgemeine Befehle

Kursiv = *Kursiv*

Fett = **Fett**

Kursiver und fetter Text = ***Kursiver und fetter Text***

Durchgestrichener Text = ~~Dieser Text ist durchgestrichen.~~

Horizontale Linie = ***

Horizontale Linie = ---


Code

Code einfügen = Am Anfang und am Ende einer Zeile

Code Block – Möglichkeit 1

```
Code Block
```

Code Block – Möglichkeit 2
Einrücken um 4 Leerzeichen

Test
Test2

Überschriften

Überschrift 1 = # Überschrift 1
Überschrift 2 = ## Überschrift 2
Überschrift 3 = ### Überschrift 3
Überschrift 4 = #### Überschrift 4
Überschrift 5 = ##### Überschrift 5
Überschrift 6 = ###### Überschrift 6


Zeilenumbruch

Ein Zeilenumbruch wird durch 2 Leerzeichen am Zeilenende erwungen

Ohne Zeilenumbruch
Erste Zeile Zweite Zeile

Mit Zeilenumbruch
Erste Zeile
Zweite Zeile


Checkliste/Aufgabenliste

  • [ ] Text
  • [ ] Text
- [ ] Text muss angegeben werden
- [ ] Text muss angegeben werden

 

Markdown-Spickzettel herunterladen

Den Spickzettel gibt es auch auf Codeberg zum herunterladen.
https://codeberg.org/strobelstefan.org/Markdown

Atom Editor entfernet die Leerzeichen am Ende einer Markdown-Zeile

Ich verwende den Atom Editor auch für das Verfassen von Dokumenten mit Markdown.

Die Markdown-Synstacx sieht zwei Leerzeichen am Zeilenende als einen Zeilenumbruch an und setzt den weiteren Text automatisch in die nächste Zeile.

In meinem Notepad++ Editor funktioniert das auch wunderbar, sobald ich die gleichen Dateien aber mit Atom bearbeitet und gespeichert habe, war der Zeilenumbruch weg.

Der Editor hat die zwei Leerzeichen am Ende einfach entfernt, was mit bei ein paar Dokumenten die Formatierung durcheinander gewirbelt hat.

Nach einigem Suchen bin ich auf die Lösung des Problems gestoßen.

Es gibt in den Core Packages das Paket „whitespace„, dass dafür das Verhalten verantwortlich ist.

In den „Einstellungen“ von whitespace ist der Hacken vor dem Eintrag „Remove Trailing Whitespace“ zu entfernen und schon bleiben die Leerzeichen am Zeilenende erhalten.