MARKTerm

Markterm is a library and program to render Markdown to a terminal. It's inspired by Glow and implemented using Markd

It can also render Markdown to Markdown if you really need that :-)

Features

• It will syntax highlight code blocks
• It will try to handle light and dark terminal themes. Since it uses the terminal's colors, it should match things like vs code themes in the vs code terminal, etc.
• In general it tries to look good and not gaudy
• It will do the right thing if output is not a tty
• Can be used as a library or as a program

TODO

• ✅ Configurable themes
• ✅ Implement HTML-style links as supported in kitty/alacritty
• ✅ Don't break paragraphs on soft breaks
• ✅ Implement images as supported in kitty (requires timg, kinda buggy)
• ✅ Images in all terminals (requires catimg, kinda useless)
• ✅ Implement HTML block support
• ✅ Better textual image display when images are not supported
• ✅ Maybe only support timg with options
• ✅ Support being used in a pipeline
• ✅ Task lists, GFM alerts, wrapped tables
• ✅ Footnotes
• Implement internal piping to $PAGER
• Allow enabling/disabling images/html-style-links via CLI (partly done)
• Use crystal-term/color to detect color capabilities
• Wrap styled table cells at word boundaries when tables are squeezed

Usage as a program

Either get a static binary from the releases page or build from source:

• Install crystal
• Checkout the repo
• run shards build

This is the help:

Markterm - A tool to render markdown to the terminal

Usage:
  markterm <file> [-t <theme>][--code-theme <code-theme>][-l]
  markterm -h | --help
  markterm --version

Options:
  -h --help                  Show this screen.
  -t <theme>                 Theme to use for coloring output
  --code-theme <code-theme>  Theme to use for coloring code blocks
  --version                  Show version.
  -l                         Force html-like links

If you use "-" as the file argument, markterm will read from stdin.

There is a similar markmark binary that will render markdown to markdown.

Usage as a library

1. Add the dependency to your shard.yml:

   dependencies:
     markterm:
       github: ralsina/markterm

In your code, use it like this:

  puts Markd.to_term(source)
  puts Markd.to_md(source)

Contributing

1. Fork it (https://github.com/ralsina/markterm/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• Roberto Alsina - creator and maintainer