Improve manpage format #488
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Use title case for headlines (automatically transformed to uppercase in manpage transform) * Uniformly use bold text for code highlights (backticks do not work)
|
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. |
|
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These improvements affect both the manpage format and enable a decent HTML rendering (see crystal-lang/crystal-book#476).