Documenter.jl icon indicating copy to clipboard operation
Documenter.jl copied to clipboard

Heading styling in admonitions

Open mortenpi opened this issue 4 years ago • 2 comments

Headings in admonitions get the same stying as the main body. They should probably be a bit smaller:

Screenshot from 2020-07-08 21-54-01

X-ref: https://github.com/JuliaLang/julia/pull/36563#discussion_r451386351

mortenpi avatar Jul 08 '20 09:07 mortenpi

Isn't this just a case of user-beware? To make a smaller header, use more #. Having different styling just adds complexity.

odow avatar Oct 21 '21 07:10 odow

It is a bit difficult to know what level of heading is correct if you write a docstring that will then be embedded in a document. I think it would be nice to if heading sizes where somehow relative the size of the note heading.

Having different styling just adds complexity.

This is true though, and it is pretty easy to fix it for your own case with more #.

I wonder if there are already styling differences like this for admonitions? In that case it might not be too difficult to add one more rule.

fredrikekre avatar Oct 21 '21 09:10 fredrikekre