mdcat

mdcat

cat mewah untuk Markdown (yaitu, CommonMark):

 $ mdcat sample.md

mdcat di WezTerm, dengan "One Light (base16)", "Gruvbox Light", dan "Darcula (base16)" (dari kiri ke kanan), dan JetBrains Mono sebagai font.

Fitur

mdcat berfungsi paling baik dengan iTerm2, WezTerm, dan kitty, dan font terminal yang bagus dengan karakter miring. Lalu itu

• merender semua sintaks dasar CommonMark dengan baik,
• menyoroti blok kode dengan syntect,
• menunjukkan tautan, dan juga gambar sebaris di terminal yang didukung (lihat di atas, di mana "Rust" adalah tautan yang dapat diklik!),
• menambahkan tanda lompat untuk judul di iTerm2 (melompat maju dan mundur dengan ⇧⌘↓ dan ⇧⌘↑).

Terminal	Sintaks dasar	Penyorotan sintaksis	Gambar	Tanda lompat
ANSI dasar¹	✓	✓
Konsol Windows 10	✓	✓
Terminologi	✓	✓	✓
iTerm2	✓	✓	✓³	✓
kucing	✓	✓	✓³
WezTerm	✓	✓	✓³
Kode VSC	✓	✓	✓³
Hantu	✓	✓	✓³

1. mdcat mengharuskan terminal mendukung pemformatan coretan dan tautan sebaris. Itu tidak akan menampilkan teks dan tautan yang dicoret dengan benar pada terminal yang tidak mendukungnya (misalnya konsol teks Linux)
2. VTE adalah perpustakaan emulasi terminal Gnome yang digunakan oleh banyak emulator terminal populer di Linux, termasuk Terminal Gnome, Terminal Xfce, Tilix, dll.
3. Gambar SVG dirender dengan resvg, lihat dukungan SVG.

Tidak didukung:

• Ekstensi CommonMark untuk catatan kaki.
• Markup sebaris dan pembungkusan teks dalam sel tabel.

Penggunaan

Coba mdcat --help atau baca halaman manual mdcat(1).

Instalasi

• Rilis biner yang dibangun di Github Actions.
• Paket pihak ketiga di Repology
• Anda juga dapat membuat mdcat secara manual dengan cargo install mdcat (lihat detailnya di bawah).

mdcat dapat ditautkan atau disalin ke mdless ; jika dipanggil sebagai mdless maka secara otomatis menggunakan pagination.

Bangunan

Jalankan cargo build --release . Tautan mdcat yang dapat dieksekusi terhadap perpustakaan SSL sistem, yaitu openssl di Linux.

Untuk membangun executable mandiri, gunakan cargo build --features=static ; executable yang dihasilkan menggunakan implementasi Rust SSL murni. Namun ia masih menggunakan akar CA sistem.

Kemasan

Saat mengemas mdcat Anda mungkin ingin menyertakan artefak tambahan berikut:

• Symlink atau hardlink dari mdless ke mdcat (lihat di atas).

• Penyelesaian shell untuk shell yang relevan, dengan memanggil mdcat --completions setelah pembangunan, misalnya

  $ 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

• Pembuatan halaman manual mdcat.1.adoc , menggunakan 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 

Pemecahan masalah

mdcat dapat menampilkan informasi penelusuran ekstensif ketika diminta. Jalankan mdcat dengan $MDCAT_LOG=trace untuk informasi penelusuran lengkap, atau dengan $MDCAT_LOG=mdcat::render=trace untuk melacak rendering saja.

Lisensi

Hak Cipta Sebastian Wiesner [email protected]

Biner tunduk pada ketentuan Lisensi Publik Mozilla, v. 2.0, lihat LISENSI.

Sebagian besar sumber tunduk pada ketentuan Lisensi Publik Mozilla, v. 2.0, lihat LISENSI, kecuali dinyatakan lain; beberapa file tunduk pada persyaratan lisensi Apache 2.0, lihat http://www.apache.org/licenses/LICENSE-2.0