Markdown CLI viewer with VI keybindings

by taf2 • 5 months ago

84 35 5 months ago

juancn• 5 months ago

A screenshot would be a nice addition to the readme.

It seems is only pure text (no support for image extensions of a terminal, just a link to the image), based on this: https://github.com/taf2/mdvi/blob/master/src/renderer.rs

It looks nice and clean code.

taf25• 5 months ago

Thanks i added a screenshot and in 0.2 you can see images now in the cli too

m4r71n• 5 months ago

The screenshot you added uses a transparent terminal where you can see your Discord chat in the background. You might want to remove that ;-)

verdverm• 5 months ago

https://github.com/charmbracelet/glamour

Charm Glamour with a view port uses basic vi keybinds as well

maxsimb• 5 months ago

https://github.com/Vagab/mark similar tool, but with editing enabled also!

eyjafjalajokull• 5 months ago

It’s funny to see markdown tools popping up with the rise of agents.

piekvorst• 5 months ago

Isn’t vi good enough?

munk-a• 5 months ago

No, I prefer emacs.

syngrog662• 5 months ago

makes sign of cross, and hisses

kurtis_reed• 5 months ago

vi was mentioned because this software has "VI keybindings". no one asked what you prefer.

w0m• 5 months ago

NeoVim w/ render-markdown.nvim

(not to poo on OP - I dig a clean TUI renderer, I have BAT installed for a reason)

Blackarea2• 5 months ago

Bat is nice. Oh dang now i have to try this plugin. I remember trying a couple of similar ones that got me so frustrated that i abandoned the idea of markdown viewers in nvim... Here we go again XD

llimllib• 5 months ago

I created one I like: https://github.com/llimllib/mdriver

it can echo images with kitty image protocol, and streams the output, which I use to show LLM output as it arrives

It doesn't handle paging - you can pipe it to `less` or whatever pager for that

syngrog662• 5 months ago

ie. vim

taf25• 5 months ago

aka view

pss314• 5 months ago

Markdown reader using find, fzf and lnav

  find . \( -path '*/vendor/*' -or -path '*/.git/*' -or -path '*/node_modules/*' \) -prune -or -type f -name "*.md" -print | fzf | xargs lnav

In the above command, the find command excludes directories such as "vendor" (golang), ".git" (git) and "node_modules" (nodejs). The lnav itself provides the markdown support https://lnav.org/2022/08/06/markdown-support.html

Blackarea2• 5 months ago

3 source files, nice code, no vibe-coding slob, nice little project... That's rare these days

gigatexal• 5 months ago

You had me at vi bindings

jonaustin• 5 months ago

Glow is pretty great and has been around for a while:

https://github.com/charmbracelet/glow

ghost-of-dmr• 5 months ago

Markdown is already readable as-is. How is this any different from running "more my_file.md" ?

Stop trying to re-invent the wheel when the tools are already there.

collinvandyck76• 5 months ago

This is an odd comment on "Hacker" news. There's a joy to be had in making things like this, even though there are better alternatives and it's often a weird thing to do in the first place. I often do not post the things I create here and elsewhere because I dread this kind of feedback. What do you hope OP takes away from your post?

taf25• 5 months ago

Great question- rather then having to push a change to GitHub to see the format changes you can just mdvi it now. Iterate locally is nice

smoyer• 5 months ago

Here's the one I use a lot ... And the underlying `glamour` library is great for programmatic markdown display: https://github.com/charmbracelet/glow.

metalliqaz• 5 months ago

It's funny because the whole idea of Markdown is that it is readable both as text and rendered, so it shouldn't require a terminal renderer.

joshka• 5 months ago

Hey if there's significant overlap, what about coming and collab-ing on https://github.com/joshka/tui-markdown? (crate + cli, rust / ratatui / crossterm based)

socceroos• 5 months ago

I personally would have liked colours support like Glow has. At least the ability to theme it so we can add colours if we want. Nice tool, though.

nikvdp• 5 months ago

If you like the man page aesthetic, using pandoc with groff is the most readable way to read markdown on the terminal I've found:

    mdless() {
        if command -v pandoc >/dev/null; then
            if [[ -z "$1" ]]; then
                cat | pandoc -s -f markdown -t man | groff -T utf8 -man | less
            else
                pandoc -s -f markdown -t man "$*" | groff -T utf8 -man | less
            fi
        else
            less "$@"
        fi
    }

Markdown CLI viewer with VI keybindings

Related Stories