diff options
Diffstat (limited to 'system/mdcat-bin/README')
| -rw-r--r-- | system/mdcat-bin/README | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/system/mdcat-bin/README b/system/mdcat-bin/README new file mode 100644 index 0000000000..e7bb8ac065 --- /dev/null +++ b/system/mdcat-bin/README @@ -0,0 +1,24 @@ +mdcat-bin (cat and less for markdown) + +mdcat is a fancy "cat" (or "less") for Markdown (aka CommonMark). +mdcat renders Markdown in a terminal, using escape codes for +highlighting and formatting. It works in any terminal, including the +Linux console, but some features (e.g. italics, strikethrough, images) +are only supported on certain terminals (such as kitty, for images). + +For convenience, mdcat is also installed as mdless (which behaves the +same as "mdcat -p"). + +The package installs completion support for bash (requires +bash-completion from Slackware /extra), zsh, and fish, and +tab-completion should "just work" after the package is installed. + +PowerShell completion is also included, but has to be manually +set up. To do this, edit your PowerShell profile (usually +~/.config/powershell/profile.ps1) and add the following lines: + +/usr/share/mdcat-bin/powershell-completions/_mdcat.ps1 +/usr/share/mdcat-bin/powershell-completions/_mdless.ps1 + +This is a repack of the official binary, which only exists for +x86_64. There are no 32-bit or aarch64 binaries, sorry. |