Create an auto man page

dbrgn / tealdeer

A very fast implementation of tldr in Rust.

https://dbrgn.github.io/tealdeer/

Apache License 2.0

4.06k stars 123 forks source link

Create an auto man page #325

Open tjapro opened 1 year ago

tjapro commented 1 year ago

I know this seems to be irrelevant and/or redundant, but sometimes we need more info about tldr. In this case, would be better to have more information in man tldr or man tealdeer. Currently, there is no man page.

In the man page could be all auto-parsed documentation from github pages.

Any thoughts?

Posted originally in https://github.com/tldr-pages/tldr/discussions/10214.
Related: https://github.com/dbrgn/tealdeer/issues/218

niklasmohrin commented 1 year ago

Sounds like a cool idea, but I don't think it will be very easy. For starters, not all chapters from the online documentation would need to be included, for example "installation" or "usage" (instead of the current "usage", a more thorough explanation could be used or maybe just "examples"). Then, we need to figure out how the generation would actually work - maybe mdbook can do it on its own already? So, if anyone comes up with something working that is not too complicated, I would not oppose including it :)