Styles for headers inside user markdown #64
Merged
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
When markdown is used inside jsdoc, any headers are just emitted as is; in practice this leads to bigger headers inside smaller headers (h1 inside h2 in the readme), which does not look very good. This commit introduces a special set of header styles for use inside documentation, which makes the case above look great.
|
ok, I see the problem, but don't think Source Pro Code font fits there stylistically. |
|
Hmm, I tried this and I do not think that's enough. Expressing five levels of headers accurately using just font size, style & margin is already very hard. Either your h1 and h2 become to big, or your h5 are barely visible any more. Double the amount would be extremely difficult to accurately represent… I think using a distinct font is the best way to achieve this; personally I do like source code pro, but that is completely a matter of taste… which font would you like? |
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.
When markdown is used inside jsdoc, any headers are just emitted
as is; in practice this leads to bigger headers inside smaller
headers (h1 inside h2 in the readme), which does not look very good.
This commit introduces a special set of header styles for use inside
documentation, which makes the case above look great.