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

Create an auto man page #325

Open
tjapro opened this issue May 17, 2023 · 1 comment
Open

Create an auto man page #325

tjapro opened this issue May 17, 2023 · 1 comment
Labels

Comments

@tjapro
Copy link

tjapro commented May 17, 2023

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 tldr-pages/tldr#10214.
Related: #218

@niklasmohrin
Copy link
Collaborator

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 :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants