MD-TUI. A markdown renderer for the terminal

131 points The_Big_Hen

I take my notes in plain markdown using NeoVim, and I wanted preview the files directly in the terminal. NeoVim itself works, but it wasn't "pretty" enough. I tried Glow, but following links didn't work as I wanted. So I created MD-TUI. It has a file browser which finds all markdown files recursively. Optionally use gitignore to filter out some.

I decided to write my own grammar for the markdown language, so it does follow a specification 100%, but create an issue if you feel like it doesn't parse something correctly. Most of the common markdown syntax should be supported.

If your terminal support some image protocol, it can also display images. Syntax highlighting is supported for some languages, and I am adding more as we speak.

The biggest feature I have not seen other do, is a "select link" mode which allows you to scroll through the links in the file and follow them. Does not matter if it's a link to a heading, another file, or external URL to a website.

Would be awesome to hear your thoughts.

https://preview.redd.it/31aa4kmbdj0d1.png?width=1742&format=png&auto=webp&s=cb1e4a9b912146a3a87ea0b6be84946ddacdcd80