Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document how the README are processed on Typst Universe #1375

Open
jdpieck opened this issue Dec 3, 2024 · 2 comments
Open

Document how the README are processed on Typst Universe #1375

jdpieck opened this issue Dec 3, 2024 · 2 comments
Labels
meta A PR that is not for a package, but for the package system itself.

Comments

@jdpieck
Copy link
Contributor

jdpieck commented Dec 3, 2024

Description

I have noticed that a package home page like the the one for oasis-align does not have the first level headings that can be found on the project's README.md. Considering that there is no documentation on the typst/packages to advise against the use of first level headers (only one "#"), I am lead to believe that this is a bug.

Image Examples

On Github

image

On Typst Universe

image

Reproduction URL

No response

Browsers

Chrome

OS

Windows

@jdpieck jdpieck added the bug There is a bug with the package bundler, the workflow, or infrastructure. No package bugs! label Dec 3, 2024
@elegaanz
Copy link
Member

elegaanz commented Dec 3, 2024

This is a feature, for SEO and accessibility reason there should only be one <h1> tag per page, and there is one in the header above the README already, so the ones in the README are removed. Maybe this could be documented though.

@elegaanz elegaanz transferred this issue from typst/webapp-issues Dec 3, 2024
@elegaanz elegaanz changed the title [Typst Universe] Package home-page/READMEs do not display first-level headings (single hashtags "#") Document how the README are processed on Typst Universe Dec 3, 2024
@elegaanz elegaanz added meta A PR that is not for a package, but for the package system itself. and removed bug There is a bug with the package bundler, the workflow, or infrastructure. No package bugs! labels Dec 3, 2024
@alerque
Copy link

alerque commented Dec 3, 2024

This is a feature, [...] so the ones in the README are removed.

This is a bug.

If there should not be more level 1 headers then demote them to whatever level they should be and adjust even deeper levels to match. Don't just scrub them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta A PR that is not for a package, but for the package system itself.
Projects
None yet
Development

No branches or pull requests

3 participants