mdcat

mdcat

cat fantaisie pour Markdown (c'est-à-dire CommonMark) :

 $ mdcat sample.md

mdcat dans WezTerm, avec "One Light (base16)", "Gruvbox Light" et "Darcula (base16)" (de gauche à droite) et JetBrains Mono comme police.

Caractéristiques

mdcat fonctionne mieux avec iTerm2, WezTerm et kitty, ainsi qu'une bonne police de terminal avec des caractères italiques. Ensuite, il

• restitue joliment toute la syntaxe de base de CommonMark,
• met en évidence les blocs de code avec syntect,
• affiche des liens, ainsi que des images en ligne dans les terminaux pris en charge (voir ci-dessus, où "Rust" est un lien cliquable !),
• ajoute des marques de saut pour les titres dans iTerm2 (sauter en avant et en arrière avec ⇧⌘↓ et ⇧⌘↑).

Terminal	Syntaxe de base	Mise en évidence de la syntaxe	Images	Marques de saut
ANSI de base¹	✓	✓
Console Windows 10	✓	✓
Terminologie	✓	✓	✓
iTerm2	✓	✓	✓³	✓
minou	✓	✓	✓³
WezTerm	✓	✓	✓³
VSCode	✓	✓	✓³
Fantôme	✓	✓	✓³

1. mdcat nécessite que le terminal prenne en charge le formatage barré et les liens en ligne. Il ne rendra pas correctement le texte barré et les liens sur les terminaux qui ne les prennent pas en charge (par exemple la console de texte Linux)
2. VTE est la bibliothèque d'émulation de terminal de Gnome utilisée par de nombreux émulateurs de terminal populaires sous Linux, notamment Gnome Terminal, Xfce Terminal, Tilix, etc.
3. Les images SVG sont rendues avec resvg, voir Prise en charge SVG.

Non pris en charge :

• Extension CommonMark pour les notes de bas de page.
• Balisage en ligne et habillage du texte dans les cellules du tableau.

Usage

Essayez mdcat --help ou lisez la page de manuel mdcat(1).

Installation

• Publier des binaires construits sur Github Actions.
• Forfaits tiers chez Repology
• Vous pouvez également créer mdcat manuellement avec cargo install mdcat (voir ci-dessous pour plus de détails).

mdcat peut être lié ou copié dans mdless ; s'il est invoqué comme mdless il utilise automatiquement la pagination.

Bâtiment

Exécutez cargo build --release . L'exécutable mdcat résultant est lié à la bibliothèque SSL du système, c'est-à-dire openssl sous Linux.

Pour créer un exécutable autonome, utilisez cargo build --features=static ; l'exécutable résultant utilise une implémentation pure de Rust SSL. Cependant, il utilise toujours les racines CA du système.

Conditionnement

Lors du packaging mdcat vous souhaiterez peut-être inclure les artefacts supplémentaires suivants :

• Un lien symbolique ou un lien physique de mdless vers mdcat (voir ci-dessus).

• Complétions de shell pour les shells pertinents, en appelant mdcat --completions après la construction, par exemple

  $ 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

• Une version de la page de manuel mdcat.1.adoc , utilisant 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 

Dépannage

mdcat peut générer des informations de traçage détaillées lorsque cela lui est demandé. Exécutez mdcat avec $MDCAT_LOG=trace pour obtenir des informations de traçage complètes, ou avec $MDCAT_LOG=mdcat::render=trace pour suivre uniquement le rendu.

Licence

Copyright Sebastian Wiesner [email protected]

Les binaires sont soumis aux termes de la licence publique Mozilla, v. 2.0, voir LICENCE.

La majeure partie de la source est soumise aux termes de la licence publique Mozilla, v. 2.0, voir LICENCE, sauf indication contraire ; certains fichiers sont soumis aux termes de la licence Apache 2.0, voir http://www.apache.org/licenses/LICENSE-2.0