mdcat

mdcat

cat chique para Markdown (ou seja, CommonMark):

 $ mdcat sample.md

mdcat no WezTerm, com "One Light (base16)", "Gruvbox Light" e "Darcula (base16)" (da esquerda para a direita) e JetBrains Mono como fonte.

Características

mdcat funciona melhor com iTerm2, WezTerm e kitty, e uma boa fonte de terminal com caracteres em itálico. Então

• renderiza bem toda a sintaxe básica do CommonMark,
• destaca blocos de código com syntect,
• mostra links e também imagens embutidas em terminais suportados (veja acima, onde "Rust" é um link clicável!),
• adiciona marcas de salto para títulos no iTerm2 (avançar e retroceder com ⇧⌘↓ e ⇧⌘↑).

terminal	Sintaxe básica	Destaque de sintaxe	Imagens	Marcas de salto
ANSI básico¹	✓	✓
Consola do Windows 10	✓	✓
Terminologia	✓	✓	✓
iTerm2	✓	✓	✓³	✓
gatinho	✓	✓	✓³
WezTerm	✓	✓	✓³
Código VSC	✓	✓	✓³
Fantasmagórico	✓	✓	✓³

1. mdcat requer que o terminal suporte formatação tachada e links embutidos. Ele não renderizará texto tachado e links corretamente em terminais que não os suportam (por exemplo, o console de texto do Linux)
2. VTE é a biblioteca de emulação de terminal do Gnome usada por muitos emuladores de terminal populares no Linux, incluindo Gnome Terminal, Xfce Terminal, Tilix, etc.
3. Imagens SVG são renderizadas com resvg, consulte suporte SVG.

Não suportado:

• Extensão CommonMark para notas de rodapé.
• Marcação embutida e quebra automática de texto nas células da tabela.

Uso

Tente mdcat --help ou leia a página de manual mdcat(1).

Instalação

• Libere binários criados em Github Actions.
• Pacotes de terceiros na Repology
• Você também pode construir mdcat manualmente com cargo install mdcat (veja detalhes abaixo).

mdcat pode ser vinculado ou copiado para mdless ; se invocado como mdless ele usa paginação automaticamente.

Prédio

Execute cargo build --release . O executável mdcat resultante vincula-se à biblioteca SSL do sistema, ou seja, openssl no Linux.

Para construir um executável independente, use cargo build --features=static ; o executável resultante usa uma implementação Rust SSL pura. No entanto, ele ainda usa as raízes da CA do sistema.

Embalagem

Ao empacotar mdcat você pode incluir os seguintes artefatos adicionais:

• Um link simbólico ou hardlink de mdless para mdcat (veja acima).

• Conclusões de shell para shells relevantes, invocando mdcat --completions após a construção, por exemplo

  $ 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

• Uma construção da página man 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 

Solução de problemas

mdcat pode gerar informações de rastreamento extensas quando solicitado. Execute mdcat com $MDCAT_LOG=trace para obter informações completas de rastreamento ou com $MDCAT_LOG=mdcat::render=trace para rastrear apenas a renderização.

Licença

Direitos autorais Sebastian Wiesner [email protected]

Os binários estão sujeitos aos termos da Licença Pública Mozilla, v. 2.0, consulte LICENÇA.

A maior parte da fonte está sujeita aos termos da Licença Pública Mozilla, v. 2.0, consulte LICENÇA, salvo indicação em contrário; alguns arquivos estão sujeitos aos termos da licença Apache 2.0, consulte http://www.apache.org/licenses/LICENSE-2.0