remark-lint-docusaurus-empty-lines-around-admonition-content

remark-lint-docusaurus-empty-lines-around-admonition-content

remark-lint rule to warn when an admonition does not have empty lines around its content.

Useful to prevent shooting yourself in the foot when using Docusaurus and Prettier (see Admonitions – Usage with Prettier).

Contents

• What is this?
• Install
• Use
• API
• Examples
• License

What is this?

This package is a unified (remark) plugin, specifically a remark-lint rule.

Lint rules check markdown code style.

Install

This package is ESM only.

In Node.js (16.0+), install with npm:

npm install --save-dev remark-lint-docusaurus-empty-lines-around-admonition-content

Use

On the API:

import {read} from 'to-vfile'
import {reporter} from 'vfile-reporter'
import {remark} from 'remark'
import remarkLint from 'remark-lint'
import remarkLintDocusaurusEmptyLinesAroundAdmonitionContent from 'remark-lint-docusaurus-empty-lines-around-admonition-content'

main()

async function main() {
  const file = await remark()
    .use(remarkLint)
    .use(remarkLintDocusaurusEmptyLinesAroundAdmonitionContent)
    .process(await read('example.md'))

  console.error(reporter(file))
}

On the CLI:

remark --use remark-lint --use remark-lint-docusaurus-empty-lines-around-admonition-content example.md

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

 …
 "remarkConfig": {
   "plugins": [
     …
     "remark-lint",
+    "remark-lint-docusaurus-empty-lines-around-admonition-content",
     …
   ]
 }
 …

API

unified().use(remarkLintNoUnneededFullReferenceLink[, config])

This rule supports standard configuration that all remark lint rules accept (such as false to turn it off or [1, options] to configure it).

There are no options.

Examples

See test/test.md or run the test with npm test.

License

MIT © Riccardo Odone