Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
remark-lint-no-multiple-toplevel-headings
Advanced tools
remark-lint rule to warn when multiple top level headings are used
remark-lint
rule to warn when top-level headings are used multiple times.
This package checks that top-level headings are unique.
You can use this package to check heading structure.
This plugin is included in the following presets:
Preset | Options |
---|---|
remark-preset-lint-markdown-style-guide |
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-lint-no-multiple-toplevel-headings
In Deno with esm.sh
:
import remarkLintNoMultipleToplevelHeadings from 'https://esm.sh/remark-lint-no-multiple-toplevel-headings@4'
In browsers with esm.sh
:
<script type="module">
import remarkLintNoMultipleToplevelHeadings from 'https://esm.sh/remark-lint-no-multiple-toplevel-headings@4?bundle'
</script>
On the API:
import remarkLint from 'remark-lint'
import remarkLintNoMultipleToplevelHeadings from 'remark-lint-no-multiple-toplevel-headings'
import remarkParse from 'remark-parse'
import remarkStringify from 'remark-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'
const file = await read('example.md')
await unified()
.use(remarkParse)
.use(remarkLint)
.use(remarkLintNoMultipleToplevelHeadings)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-no-multiple-toplevel-headings .
On the CLI in a config file (here a package.json
):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-no-multiple-toplevel-headings",
…
]
}
…
This package exports no identifiers.
It exports the TypeScript types
Depth
and
Options
.
The default export is
remarkLintNoMultipleToplevelHeadings
.
unified().use(remarkLintNoMultipleToplevelHeadings[, options])
Warn when top-level headings are used multiple times.
options
(Options
, default: 1
)
— configurationTransform (Transformer
from unified
).
Depth
Depth (TypeScript type).
type Depth = 1 | 2 | 3 | 4 | 5 | 6
Options
Configuration (TypeScript type).
type Options = Depth
Documents should almost always have one main heading,
which is typically a heading with a rank of 1
.
ok.md
# Mercury
## Venus
No messages.
not-ok.md
# Venus
# Mercury
3:1-3:10: Unexpected duplicate toplevel heading, exected a single heading with rank `1`
not-ok.md
When configured with 2
.
## Venus
## Mercury
3:1-3:11: Unexpected duplicate toplevel heading, exected a single heading with rank `2`
html.md
Venus <b>and</b> mercury.
<h1>Earth</h1>
<h1>Mars</h1>
5:1-5:14: Unexpected duplicate toplevel heading, exected a single heading with rank `1`
mdx.mdx
👉 Note: this example uses MDX (
remark-mdx
).
Venus <b>and</b> mercury.
<h1>Earth</h1>
<h1>Mars</h1>
4:1-4:14: Unexpected duplicate toplevel heading, exected a single heading with rank `1`
Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line,
remark-lint-no-multiple-toplevel-headings@4
,
compatible with Node.js 16.
See contributing.md
in remarkjs/.github
for ways
to get started.
See support.md
for ways to get help.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.
FAQs
remark-lint rule to warn when multiple top level headings are used
The npm package remark-lint-no-multiple-toplevel-headings receives a total of 78,910 weekly downloads. As such, remark-lint-no-multiple-toplevel-headings popularity was classified as popular.
We found that remark-lint-no-multiple-toplevel-headings demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.