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?
#Universe first-level heading
10 messages · Page 1 of 1 (latest)
It is certainly a bug, maybe related to the html used at the file start, maybe something else. It's hard to say because this part of the app is not open-source.
It would be great to create an issue there: https://github.com/typst/webapp-issues
It also happens on a version without html at the beginning (see the 0.2.1)
I already made an issue but thanks for pointing it out 😉
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.
I'd understand stripping the first top-level header but removing the following ones does not make real sense imo 😅
do you think you will change that or shall I change all of my packages READMEs?
It was meant more as an explanation than a justification. I think we'll keep the first heading thing but the rest we can change.
yeah I understand the thought process behind it ;)
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).
oh okay didn't know that!