npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

remark-lint-maximum-heading-length

v4.0.0

Published

remark-lint rule to warn when headings are too long

Downloads

360,507

Readme

remark-lint-maximum-heading-length

Build Coverage Downloads Size Sponsors Backers Chat

remark-lint rule to warn when headings are too long.

Contents

What is this?

This package checks the length of heading text.

When should I use this?

You can use this package to check that heading text is within reason.

Presets

This plugin is included in the following presets:

| Preset | Options | | - | - | | remark-preset-lint-markdown-style-guide | |

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install remark-lint-maximum-heading-length

In Deno with esm.sh:

import remarkLintMaximumHeadingLength from 'https://esm.sh/remark-lint-maximum-heading-length@4'

In browsers with esm.sh:

<script type="module">
  import remarkLintMaximumHeadingLength from 'https://esm.sh/remark-lint-maximum-heading-length@4?bundle'
</script>

Use

On the API:

import remarkLint from 'remark-lint'
import remarkLintMaximumHeadingLength from 'remark-lint-maximum-heading-length'
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(remarkLintMaximumHeadingLength)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-maximum-heading-length .

On the CLI in a config file (here a package.json):

 …
 "remarkConfig": {
   "plugins": [
     …
     "remark-lint",
+    "remark-lint-maximum-heading-length",
     …
   ]
 }
 …

API

This package exports no identifiers. It exports no additional TypeScript types. The default export is remarkLintMaximumHeadingLength.

unified().use(remarkLintMaximumHeadingLength[, options])

Warn when headings are too long.

Parameters
  • options (number, default: 60) — preferred max size
Returns

Transform (Transformer from unified).

Recommendation

While this rule is sometimes annoying, reasonable size headings do help SEO purposes (bots prefer reasonable headings), visual users (headings are typically displayed quite large), and users of screen readers (who use “jump to heading” features that read every heading out loud to navigate within a page).

Examples

ok.md
In
# Mercury is the first planet from the Sun
Out

No messages.

not-ok.md

When configured with 30.

In
# Mercury is the first planet from the Sun
Out
1:1-1:43: Unexpected `40` characters in heading, expected at most `30` characters
mdx.mdx

When configured with 30.

In

👉 Note: this example uses MDX (remark-mdx).

<h1>Mercury is the first planet from the Sun</h1>
Out
1:1-1:50: Unexpected `40` characters in heading, expected at most `30` characters
not-ok.md

When configured with '🌍'.

Out
1:1: Unexpected value `🌍` for `options`, expected `number`

Compatibility

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-maximum-heading-length@4, compatible with Node.js 16.

Contribute

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.

License

MIT © Titus Wormer