search

riscv / docs-resources

https://lists.riscv.org/g/sig-documentation
Creative Commons Attribution 4.0 International
23 stars 14 forks source link

All heading levels have same font size #30

Closed pathakraul closed 2 months ago

pathakraul commented 2 months ago

The latest docs-resources have made all heading levels to have same font size. Visually this does not helps in differentiating between the sections and subsections.

Atleast the h1, h2, and h3 can have 2pt difference among each other.

pathakraul commented 2 months ago

Also the generated pdf has bigger code formatted text then the normal text. image

Currently we are relying on the default docs_resources provided theme , but we are willing do change if required. Please let me know

pathakraul commented 2 months ago

This is the WIP specification which i am working on https://github.com/riscv-non-isa/riscv-rpmi

pathakraul commented 2 months ago

@wmat

wmat commented 2 months ago

Sorry, just getting back at it after vacation. So interestingly, we used to have the headings font sizes getting incrementally smaller, however someone complained about that and therefore we set them all to 11.5, except for H1, which is 11.5 * 2.8.

Do you mind if we move this discussion to the Docs SIG mailing list, as I'd like to get additional opinions.

pathakraul commented 2 months ago

Not sure how heading levels can be issue, if anyone dont want different heading sizes then they can use the same heading level.

Sure lets discuss this in Docs SIG

wmat commented 2 months ago

I'm just doing some testing with the heading levels and fonts on your spec. Once I get it looking nice I'll update the docs-resources theme. I decided not to open a discussion yet. Once thing I noticed with your spec is when using a literal block (beginning a line with a space) in a table, you'll want to make sure that cell is formatted as asciidoc. You can do this by putting an a before the cell separator:

! [31]      a!

    0b0: Custom resume address not supported.
    0b1: Custom resume address supported.
! [30]      a!

    0b0: Suspend not supported
    0b1: Suspend supported

This ensures it uses the code block category keys in the theme.