Styles for headers inside user markdown

clenemt / docdash

:zap: Lodash inspired JSDoc 3 template/theme

http://clenemt.github.io/docdash/

Other

824 stars 201 forks source link

Styles for headers inside user markdown #64

Closed koraa closed 4 years ago

koraa commented 5 years ago

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.

ar2rsawseen commented 5 years ago

ok, I see the problem, but don't think Source Pro Code font fits there stylistically. Maybe just decreasing inner .usertext heading size is ok?

koraa commented 5 years ago

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?