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

Improve manpage format #488

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

straight-shoota
Copy link
Member

  • Use title case for headlines (automatically transformed to uppercase in manpage transform)
  • Uniformly use bold text for code highlights (backticks do not work)

These improvements affect both the manpage format and enable a decent HTML rendering (see crystal-lang/crystal-book#476).

* Use title case for headlines (automatically transformed to uppercase in manpage transform)
* Uniformly use bold text for code highlights (backticks do not work)
@oprypin
Copy link
Member

oprypin commented May 31, 2021

Regarding "backticks do not work" - I see that that is not represented in any way when viewing the manpage on the terminal. OK.

I don't think it's good to change all underlines to bold, because underlines seem to have a very specific meaning - some kind of literal sample -- actually very close to what backticks would've been used with. And the underline looks very good on man pages.

@straight-shoota
Copy link
Member Author

I know, it's not an optimal result. If it was feasible, I would go for any improvement. But I think that's the best we can get for a reasonable effort. IMO the manpage representation looks reasonable and consistenst.

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

Successfully merging this pull request may close these issues.

2 participants