Skip to content

docs: update heading levels #15631

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.

Sign up for GitHub

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

Merged
kgryte merged 2 commits into from
Sep 28, 2026
Merged

docs: update heading levels #15631

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1ad87c3
docs: use level-4 API headings in `remark-lint-expected-html-sections`
claude Sep 28, 2026
f603dd4
docs: use a level-4 API heading in `remark-lint-html-section-structure`
claude Sep 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ...ules/@stdlib/_tools/remark/plugins/remark-lint-expected-html-sections/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ This plugin checks for the presence of required HTML sections in README.md files
var plugin = require( '@stdlib/_tools/remark/plugins/remark-lint-expected-html-sections' );
```

### plugin()
#### plugin()

A [remark][remark] plugin which validates the presence of expected HTML sections in README files.

Expand All @@ -54,7 +54,7 @@ function done( error, file ) {
}
```

### plugin.factory( \[options] )
#### plugin.factory( \[options] )

Returns a configured [remark][remark] plugin for validating expected HTML sections in README files.

Expand Down
2 changes: 1 addition & 1 deletion ...ules/@stdlib/_tools/remark/plugins/remark-lint-html-section-structure/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ This plugin validates the HTML section structure in README files, ensuring that:
var sectionStructure = require( '@stdlib/_tools/remark/plugins/remark-lint-html-section-structure' );
```

### sectionStructure()
#### sectionStructure()

Plugin to lint HTML section structure in README files.

Expand Down
Loading