mdcat

mdcat

cat elegante para Markdown (es decir, CommonMark):

 $ mdcat sample.md

mdcat en WezTerm, con "One Light (base16)", "Gruvbox Light" y "Darcula (base16)" (de izquierda a derecha) y JetBrains Mono como fuente.

Características

mdcat funciona mejor con iTerm2, WezTerm y kitty, y una buena fuente de terminal con caracteres en cursiva. entonces

• representa muy bien toda la sintaxis básica de CommonMark,
• resalta bloques de código con syntect,
• muestra enlaces y también imágenes en línea en terminales compatibles (ver arriba, donde "Rust" es un enlace en el que se puede hacer clic),
• agrega marcas de salto para encabezados en iTerm2 (salte hacia adelante y hacia atrás con ⇧⌘↓ y ⇧⌘ ↑).

Terminal	Sintaxis básica	Resaltado de sintaxis	Imágenes	marcas de salto
ANSI básico¹	✓	✓
consola de windows 10	✓	✓
Terminología	✓	✓	✓
iTerm2	✓	✓	✓³	✓
bote	✓	✓	✓³
WezTérmino	✓	✓	✓³
Código VS	✓	✓	✓³
fantasmal	✓	✓	✓³

1. mdcat requiere que el terminal admita formato tachado y enlaces en línea. No mostrará correctamente el texto tachado ni los enlaces en terminales que no los admitan (por ejemplo, la consola de texto de Linux).
2. VTE es la biblioteca de emulación de terminal de Gnome utilizada por muchos emuladores de terminal populares en Linux, incluidos Gnome Terminal, Xfce Terminal, Tilix, etc.
3. Las imágenes SVG se procesan con resvg; consulte compatibilidad con SVG.

No compatible:

• Extensión CommonMark para notas a pie de página.
• Marcado en línea y ajuste de texto en celdas de tabla.

Uso

Pruebe mdcat --help o lea la página de manual de mdcat(1).

Instalación

• Lanzar binarios creados en Github Actions.
• Paquetes de terceros en Repology
• También puede compilar mdcat manualmente con cargo install mdcat (consulte los detalles a continuación).

mdcat se puede vincular o copiar a mdless ; si se invoca como mdless automáticamente usa paginación.

Edificio

Ejecute cargo build --release . El ejecutable mdcat resultante se vincula con la biblioteca SSL del sistema, es decir, openssl en Linux.

Para crear un ejecutable autónomo, utilice cargo build --features=static ; el ejecutable resultante utiliza una implementación Rust SSL pura. Sin embargo, todavía utiliza las raíces de CA del sistema.

Embalaje

Al empaquetar mdcat es posible que desee incluir los siguientes artefactos adicionales:

• Un enlace simbólico o un enlace físico de mdless a mdcat (ver arriba).

• Completaciones de shell para shells relevantes, invocando mdcat --completions después de la construcción, por ejemplo

  $ 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

• Una compilación de la página de manual mdcat.1.adoc , usando 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 

Solución de problemas

mdcat puede generar información de seguimiento extensa cuando se le solicita. Ejecute mdcat con $MDCAT_LOG=trace para obtener información de seguimiento completa, o con $MDCAT_LOG=mdcat::render=trace para rastrear solo la representación.

Licencia

Copyright Sebastián Wiesner [email protected]

Los binarios están sujetos a los términos de la Licencia pública de Mozilla, v. 2.0, consulte LICENCIA.

La mayor parte de la fuente está sujeta a los términos de la Licencia pública de Mozilla, v. 2.0, consulte LICENCIA, a menos que se indique lo contrario; algunos archivos están sujetos a los términos de la licencia Apache 2.0, consulte http://www.apache.org/licenses/LICENSE-2.0