#Universe first-level heading

10 messages · Page 1 of 1 (latest)

cobalt mica
#

Hello, I noticed that on Typst Universe, the first-level headings of the README do not appear.
For instance, on this package you will not see the # Examples, # Fonts, # Notes and # License headings that are actually present in the README.md file of the package.
Is it a bug or an intended feature?

Typst

A template made for reports and other documents of INSA, a French engineering school.

glossy hedge
cobalt mica
#

I already made an issue but thanks for pointing it out 😉

simple galleon
#

Most READMEs use a top level heading for the package name and second level headings for the sections. The package name is already part of Universe's design, that's the idea of why it's stripped.

cobalt mica
simple galleon
cobalt mica
#

yeah I understand the thought process behind it ;)

narrow adder
#

I think using multiple first-level headings is not best practice, because it creates multiple HTML <h1> tags, which is not recommanded (https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements#avoid_using_multiple_h1_elements_on_one_page).

MDN Web Docs

The to HTML elements represent six levels of section headings. is the highest section level and is the lowest. By default, all heading elements create a block-level box in the layout, starting on a new line and taking up the full width available in their containing block.

cobalt mica
#

oh okay didn't know that!