You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We don't want to have titles followed directly by H1 headings. The first paragraph of every page should provide actual content. Empty heading levels (headings that immediately follow other headings) don't add value and add friction to reading and understanding the content.
Currently, every page requires both a title and the h1 heading, making one or the other of little (if any) use.
Currently, the build scripts issue a warning if the h1 heading doesn't exist.
The desired behavior is to only require one or the other instead of both. So, if the title exists, the build scripts shouldn't complain. If there's no title in the frontmatter, the build script should require the h1 heading.
Describe the solution you'd like
If a title exists in the frontmatter, the build scripts should skip checking for the h1 heading and shouldn't complain.
If there's no title in the frontmatter, the build script should require the h1 heading and complain if it's missing.
Describe alternatives you've considered
No response
Do you have any additional context?
No response
Participation
I am willing to submit a pull request for this feature request.
The text was updated successfully, but these errors were encountered:
Please confirm the following:
Is your feature request related to a problem?
We don't want to have titles followed directly by H1 headings. The first paragraph of every page should provide actual content. Empty heading levels (headings that immediately follow other headings) don't add value and add friction to reading and understanding the content.
Currently, every page requires both a title and the
h1
heading, making one or the other of little (if any) use.Currently, the build scripts issue a warning if the
h1
heading doesn't exist.The desired behavior is to only require one or the other instead of both. So, if the
title
exists, the build scripts shouldn't complain. If there's notitle
in the frontmatter, the build script should require theh1
heading.Describe the solution you'd like
If a
title
exists in the frontmatter, the build scripts should skip checking for the h1 heading and shouldn't complain.If there's no
title
in the frontmatter, the build script should require theh1
heading and complain if it's missing.Describe alternatives you've considered
No response
Do you have any additional context?
No response
Participation
The text was updated successfully, but these errors were encountered: