sensei icon indicating copy to clipboard operation
sensei copied to clipboard

Support for opening documentation in the terminal.

Open edfloreshz opened this issue 4 years ago • 3 comments

This feature will allow the user to open documentation as Markdown files directly in the terminal, without having to open the browser.

There are some libraries/utilities that could help us achieve this:

  • mdcat a fancy cat for markdown files.
  • termimad a markdown renderer for the terminal.
  • lynx a terminal web browser.

Issues to overcome:

  • [ ] Figure out a way to get crates documentation as markdown files.
  • [ ] Render documentation files in the terminal.

edfloreshz avatar Dec 10 '20 08:12 edfloreshz

@categulario he tenido intención de hacer esto pero aun no logro descifrar una buena forma de hacerlo, conoces alguna?

edfloreshz avatar Aug 31 '21 18:08 edfloreshz

You can open the html files in the terminal easily (it's the default documentation) but convert it to markdown first and then open it with an application that opens in markdown... Personally, I find it to be unnecessary complexity, unless there is a good one reason

Kedap avatar Sep 10 '21 14:09 Kedap

I've been thinking of a way to make this feature more useful than just open documentation in the terminal. Once I figure out a way I will update you, in the meantime I'll leave this open.

edfloreshz avatar Sep 10 '21 14:09 edfloreshz