[docs] Allow Markdown files to skip H1 if the page has the title keyword defined in the frontmatter
Opened this issue · 1 comments
Please confirm the following:
- I have read the Code of Conduct
- The feature was not suggested before
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 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.
This issue is stale because it is open for 60 days with no activity