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

[docs] Allow Markdown files to skip H1 if the page has the title keyword defined in the frontmatter #1183

Open
2 of 3 tasks
lsgunnlsgunn opened this issue Nov 6, 2023 · 1 comment
Labels
enhancement New feature or request no-issue-activity

Comments

@lsgunnlsgunn
Copy link
Contributor

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 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.
@lsgunnlsgunn lsgunnlsgunn added the enhancement New feature or request label Nov 6, 2023
Copy link
Contributor

github-actions bot commented Jan 6, 2024

This issue is stale because it is open for 60 days with no activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request no-issue-activity
Projects
None yet
Development

No branches or pull requests

1 participant