mdcat

mdcat

Ausgefallene cat für Markdown (das heißt CommonMark):

 $ mdcat sample.md

mdcat in WezTerm, mit „One Light (base16)“, „Gruvbox Light“ und „Darcula (base16)“ (von links nach rechts) und JetBrains Mono als Schriftart.

Merkmale

mdcat funktioniert am besten mit iTerm2, WezTerm und kitty sowie einer guten Terminalschriftart mit kursiven Zeichen. Dann ist es

• stellt die gesamte grundlegende CommonMark-Syntax gut dar,
• hebt Codeblöcke mit Syntect hervor,
• zeigt Links und auch Bilder inline in unterstützten Terminals an (siehe oben, wo „Rust“ ein anklickbarer Link ist!),
• Fügt Sprungmarken für Überschriften in iTerm2 hinzu (vorwärts und rückwärts springen mit ⇧⌘↓ und ⇧⌘ ↑).

Terminal	Grundlegende Syntax	Syntaxhervorhebung	Bilder	Sprungmarken
Grundlegendes ANSI¹	✓	✓
Windows 10-Konsole	✓	✓
Terminologie	✓	✓	✓
iTerm2	✓	✓	✓³	✓
Kätzchen	✓	✓	✓³
WezTerm	✓	✓	✓³
VSCode	✓	✓	✓³
Geisterhaft	✓	✓	✓³

1. mdcat erfordert, dass das Terminal durchgestrichene Formatierung und Inline-Links unterstützt. Auf Terminals, die diese nicht unterstützen (z. B. die Linux-Textkonsole), werden durchgestrichener Text und Links nicht korrekt wiedergegeben.
2. VTE ist die Terminalemulationsbibliothek von Gnome, die von vielen beliebten Terminalemulatoren unter Linux verwendet wird, darunter Gnome Terminal, Xfce Terminal, Tilix usw.
3. SVG-Bilder werden mit resvg gerendert, siehe SVG-Unterstützung.

Nicht unterstützt:

• CommonMark-Erweiterung für Fußnoten.
• Inline-Markup und Textumbruch in Tabellenzellen.

Verwendung

Probieren Sie mdcat --help aus oder lesen Sie die Manpage zu mdcat(1).

Installation

• Veröffentlichen Sie Binärdateien, die auf Github-Aktionen basieren.
• Pakete von Drittanbietern bei Repology
• Sie können mdcat auch manuell mit cargo install mdcat erstellen (Einzelheiten siehe unten).

mdcat kann mit mdless verknüpft oder kopiert werden; Wenn es als mdless aufgerufen wird, wird automatisch die Paginierung verwendet.

Gebäude

Führen Sie cargo build --release aus. Die resultierende ausführbare mdcat Datei verknüpft sich mit der SSL-Bibliothek des Systems, z. B. openssl unter Linux.

Um eine eigenständige ausführbare Datei zu erstellen, verwenden Sie cargo build --features=static “; Die resultierende ausführbare Datei verwendet eine reine Rust-SSL-Implementierung. Es werden jedoch weiterhin die CA-Roots des Systems verwendet.

Verpackung

Beim Packen von mdcat möchten Sie möglicherweise die folgenden zusätzlichen Artefakte einschließen:

• Ein Symlink oder Hardlink von mdless zu mdcat (siehe oben).

• Shell-Vervollständigungen für relevante Shells durch Aufrufen mdcat --completions nach dem Erstellen, z

  $ mdcat --completions fish > /usr/share/fish/vendor_completions.d/mdcat.fish
  $ mdcat --completions bash > /usr/share/bash-completion/completions/mdcat
  $ mdcat --completions zsh > /usr/share/zsh/site-functions/_mdcat
  # Same for mdless if you include it
  $ mdless --completions fish > /usr/share/fish/vendor_completions.d/mdless.fish
  $ mdless --completions bash > /usr/share/bash-completion/completions/mdless
  $ mdless --completions zsh > /usr/share/zsh/site-functions/_mdless

• Ein Build der Manpage mdcat.1.adoc mit AsciiDoctor:

  $ asciidoctor -b manpage -a reproducible -o /usr/share/man/man1/mdcat.1 mdcat.1.adoc
  $ gzip /usr/share/man/man1/mdcat.1
  # If you include a mdless as above, you may also want to support man mdless
  $ ln -s mdcat.1.gz /usr/share/man/man1/mdless.1.gz 

Fehlerbehebung

mdcat kann auf Anfrage umfangreiche Ablaufverfolgungsinformationen ausgeben. Führen Sie mdcat mit $MDCAT_LOG=trace aus, um vollständige Ablaufverfolgungsinformationen zu erhalten, oder mit $MDCAT_LOG=mdcat::render=trace um nur das Rendern zu verfolgen.

Lizenz

Copyright Sebastian Wiesner [email protected]

Binärdateien unterliegen den Bedingungen der Mozilla Public License, Version 2.0, siehe LIZENZ.

Der größte Teil der Quelle unterliegt den Bedingungen der Mozilla Public License, Version 2.0, siehe LIZENZ, sofern nicht anders angegeben; Einige Dateien unterliegen den Bedingungen der Apache 2.0-Lizenz, siehe http://www.apache.org/licenses/LICENSE-2.0