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

Headings: automatically shift 1 down in content pages #211

Open
keunes opened this issue Jan 17, 2023 · 0 comments
Open

Headings: automatically shift 1 down in content pages #211

keunes opened this issue Jan 17, 2023 · 0 comments
Labels
enhancement Improvements to existing building blocks or elements on the website

Comments

@keunes
Copy link
Member

keunes commented Jan 17, 2023

Short description: There should always be max. 1 title with H1 level. However, at the level of (some) page source files, the highest level of heading is not the page title (which is in the front matter) but the titles within the page content. When editing the content it feels correct to start with the top level heading, but this will lead to undesired result. Therefore we should:

  • automatically shift each & every title down one level (e.g. # in about.md becomes ##) - if possible
  • manually check all content such that headings start at the second level

Location: site-wide

Why have this: this enhances readabilty and (apparently) is important for accessability

More info:

@keunes keunes added the enhancement Improvements to existing building blocks or elements on the website label Jan 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvements to existing building blocks or elements on the website
Projects
None yet
Development

No branches or pull requests

1 participant