Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for opening documentation in the terminal. #6

Open
2 tasks
edfloreshz opened this issue Dec 10, 2020 · 3 comments
Open
2 tasks

Support for opening documentation in the terminal. #6

edfloreshz opened this issue Dec 10, 2020 · 3 comments
Labels
enhancement New feature or request hacktoberfest Hacktoberfest issues.

Comments

@edfloreshz
Copy link
Owner

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 edfloreshz added the enhancement New feature or request label Dec 10, 2020
@edfloreshz
Copy link
Owner Author

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

@edfloreshz edfloreshz added the hacktoberfest Hacktoberfest issues. label Sep 9, 2021
@Kedap
Copy link
Contributor

Kedap commented Sep 10, 2021

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

@edfloreshz
Copy link
Owner Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request hacktoberfest Hacktoberfest issues.
Projects
None yet
Development

No branches or pull requests

2 participants