search

henriklovhaug / md-tui

Markdown renderer in the terminal
GNU Affero General Public License v3.0
208 stars 13 forks source link

It would be nice to see `less`-compatible keybindings #112

Closed tommythorn closed 6 months ago

tommythorn commented 6 months ago

I saw a toot about this and jumped to install it, but it seemed to only display the first screen full. I expected it to work like less, but neither space, -, arrow-up/down, nor return did anything. I tried running mdt --help for a manual but it said it couldn't find --help.

I finally went to track down the home page for this and found it uses the VI conventions. Well, that was not obvious and I'd recommend adding additional keybindings.

EDIT: rephrased

henriklovhaug commented 6 months ago

Hi. Quite harsh feedback there. I agree that a help menu should be provided as a cli option, but since you tried to run it, you would have seen a help menu at the bottom with all the key binds for the relevant page. Arrows were just added, and is not yet upstream to crates. VI key binds are really common among other TUI programs. If you're not looking for a full TUI experience mdcat is a really good option.

Next time I would advise you to keep the issue more as a request of features you would like to see implemented or bugs encountered with the program, and not as a complaning page.

tommythorn commented 6 months ago

You asked for issues and I reported my experience. It looks interesting and it was definitely something that is needed. I didn’t see the help, but it could be related to the colors which made part of it unreadable (which could be the fault of my terminal settings, so I didn’t mention it).

I disagree with your expected defaults, less binding are obviously what I would expect for a terminal viewer.

henriklovhaug commented 6 months ago

Change the key binds however you see fit. https://github.com/henriklovhaug/md-tui/releases/tag/v0.8.0