Markdeep

  Ralf Hersel   Lesezeit: 2 Minuten  🗪 4 Kommentare

Eine Markdown-Variante mit sehr vielen Möglichkeiten.

markdeep

Markdeep ist eine Technologie zum Schreiben von einfachen Textdokumenten, die in jedem Webbrowser gut aussehen, egal ob lokal oder remote. Es unterstützt Diagramme, Kalender, Gleichungen und andere Funktionen als Erweiterungen der Markdown-Syntax.


Markdeep ist Open Source Software und einfach zu benutzen. Es erfordert weder ein Plugin noch eine Internetverbindung. Ein Dokument verlässt nie den Computer und es muss nichts installiert werden. Man schreibt den erweiterten Markdown-Code in einem beliebigen Texteditor. Das Dokument wird nicht exportiert, kompiliert oder anderweitig bearbeitet. Es muss die Endung .md.html haben und kann in jedem Webbrowser geöffnet werden.

Die Auszeichnungssprache ist ideal für Designdokumente, Spezifikationen, README-Dateien, Codedokumentation, Laborberichte, Blogs und technische Webseiten. Da es sich bei der Quelle um reinen Text handelt, funktioniert Markdeep gut mit Softwareentwicklungs-Toolchains. Markdeep wurde von Morgan McGuire (Casual Effects) entwickelt, inspiriert von John Grubers Markdown und Donald Knuths und Leslie Lamports LaTeX.

Jede Markdeep-Datei muss am Ende diese Codezeile enthalten:

<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>

Die Liste der Funktionen ist sehr beeindruckend und geht weit über das hinaus, was mit Markdown möglich ist.

Quelle: https://casual-effects.com/markdeep/

Tags

Markdeep, README-Dateien, Casual, Effects, Webbrowser, Markdown, Dokument, Toolchains, Softwareentwicklungs

Bernhard E. Reiter
Geschrieben von Bernhard E. Reiter am 22. Februar 2022 um 20:33

Für mich scheint Markdeep gegen das Minimalgebot für Datenformate zu verstoßen. Erscheint mir unpraktisch.

understater
Geschrieben von understater am 23. Februar 2022 um 12:28

T'schuldigung, aber wenn ich das richtig sehe braucht es doch eine Internetverbindung!

Immerhin steht ja in der notwendigen Codezeile: https://morgan3d.github.io/markdeep/latest/markdeep.min.js

Ohne Zugriff auf diesen Link scheint das nicht zu funktionieren!

@Bernhard Reiter Meinst Du mit dem "Verstoß gegen das Minimalgebot" diesen notwendigen Link?

doppelNull
Geschrieben von doppelNull am 6. März 2022 um 00:22

"Immerhin steht ja in der notwendigen Codezeile:"

Das kannst du löschen bzw. auskommentieren, sofern du das Skript im selben Verzeichnis wie deine .md.html Datei abgespeichert hast.

sh
Geschrieben von sh am 4. März 2022 um 13:09

@understater

Speichere markdeep.min.js im selben Verzeichnis wie deine ".md.html" Datei und kommentiere die script Zeile mit dem https aus. Es läuft auch so ohne den Verweis.