Markdown 用のファンシーcat
(つまり CommonMark):
$ mdcat sample.md
WezTerm の mdcat。左から右に「One Light (base16)」、「Gruvbox Light」、「Darcula (base16)」、フォントとして JetBrains Mono を使用します。
mdcat
、iTerm2、WezTerm、kitty、および斜体文字を含む適切な端末フォントで最もよく機能します。それからそれ
ターミナル | 基本的な構文 | 構文の強調表示 | 画像 | ジャンプマーク |
---|---|---|---|---|
基本的な ANSI¹ | ✓ | ✓ | ||
Windows 10 コンソール | ✓ | ✓ | ||
用語 | ✓ | ✓ | ✓ | |
iTerm2 | ✓ | ✓ | ✓3 | ✓ |
子猫 | ✓ | ✓ | ✓3 | |
ウェズターム | ✓ | ✓ | ✓3 | |
VSコード | ✓ | ✓ | ✓3 | |
ゴーストティ | ✓ | ✓ | ✓3 |
サポートされていないもの:
mdcat --help
を試すか、mdcat(1) マンページを読んでください。
cargo install mdcat
を使用してmdcat
手動でビルドすることもできます (詳細については以下を参照)。 mdcat
mdless
にリンクまたはコピーできます。 mdless
として呼び出された場合は、自動的にページネーションが使用されます。
cargo build --release
実行します。結果として得られるmdcat
実行可能ファイルは、システムの SSL ライブラリ、つまり Linux 上の openssl にリンクします。
自己完結型の実行可能ファイルをビルドするには、 cargo build --features=static
使用します。結果として得られる実行可能ファイルは、純粋な Rust SSL 実装を使用します。ただし、システムの CA ルートは引き続き使用されます。
mdcat
をパッケージ化するときは、次の追加アーティファクトを含めることができます。
mdless
からmdcat
へのシンボリックリンクまたはハードリンク (上記を参照)。
ビルド後にmdcat --completions
を呼び出すことによる、関連するシェルのシェル補完。例:
$ 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
AsciiDoctor を使用したマニュアル ページmdcat.1.adoc
のビルド:
$ 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
mdcat
要求に応じて広範なトレース情報を出力できます。完全なトレース情報を取得するには$MDCAT_LOG=trace
指定してmdcat
実行するか、レンダリングのみをトレースするには$MDCAT_LOG=mdcat::render=trace
を指定して mdcat を実行します。
Copyright Sebastian Wiesner [email protected]
バイナリには、Mozilla Public License v. 2.0 の条件が適用されます (「ライセンス」を参照)。
ソースの大部分は、特に明記されていない限り、Mozilla Public License v. 2.0 の条項に従うものとします。ライセンスを参照してください。一部のファイルには Apache 2.0 ライセンスの条件が適用されます。http://www.apache.org/licenses/LICENSE-2.0 を参照してください。