Termimad: use Markdown to display rich text in a terminal application

announcements
1

The goal of Termimad isn't to deal with existing markdown documents, but to provide an easy way to display a scrollable help screen, or small rich text snippets, in your terminal based application (using crossterm).

  • easily type and build simple texts with small formatting
  • separate colors from content in your code (shines when application colors are user configurable)
  • wrap and justify text and tables, according to your terminal width

Here's an example (from broot):

20190618-broot-help-2

I have no idea whether many devs will find this as convenient as I do.
Or how many of you will just find this ridiculously niche.
Or already have a better solution.
But I'll be interested in your opinion.

21 Likes
2

I love it!

1 Like
3

Sounds like a nice alternative to man pages / texinfo.

1 Like
4

Thanks. There are probably many features I didn't find useful enough to implement but that would be needed by other programmers. Don't hesitate to ask.

5

Have you considered to make the feature of showing slides as well? Like mdp or patat.

6

No I didn't, that wasn't my use case. But I might be misunderstanding you: you're linking us to two fine looking tools, why would the world need a third one ? To embed slides as part of a bigger terminal application ?

7

Have you considered syntax highlighting for code blocks?

1 Like
8

Not until now. This is an interesting idea. I could look into it (with probably optional dependencies) if there's some interest.

3 Likes
9

I have no idea whether many devs will find this as convenient as I do.

Good job!

We were just talking on cargo-release about wanting to ship some of the markdown help, so I'd find this very useful.

1 Like
10

Cool. Don't hesitate to call for help for your integration.

(and thanks for cargo-release, btw. I'll probably use it to ease my releases)

11

I would second this.
I think that having syntax highlighting would be quite useful.

syntect or something like it perhaps? (I have not used it yet just doing some looking for another project I am working on.)

12

This topic was automatically closed 90 days after the last reply. New replies are no longer allowed.