remark-directive

[![Build][badge-build-image]][badge-build-url]
[![Coverage][badge-coverage-image]][badge-coverage-url]
[![Downloads][badge-downloads-image]][badge-downloads-url]
[![Size][badge-size-image]][badge-size-url]

[remark][github-remark] plugin to support the
[generic directives proposal][commonmark-directive-proposal]
(:cite[smith04],
::youtube[Video of a cat in a box]{v=01ab2cd3efg},
and such).

Contents

* What is this?
* When should I use this?
* Install
* Use
* API
* [unified().use(remarkDirective[, options])](#unifieduseremarkdirective-options)
* Options
* Examples
* Example: YouTube
* Example: Styled blocks
* Authoring
* HTML
* CSS
* Syntax
* Syntax tree
* Types
* Compatibility
* Security
* Related
* Contribute
* License

What is this?

This package is a [unified][github-unified]
([remark][github-remark])
plugin to add support for directives:
one syntax for arbitrary extensions in markdown.

When should I use this?

Directives are one of the four ways to extend markdown:
an arbitrary extension syntax
(see [Extending markdown][github-micromark-extending-markdown]
in micromark’s docs for the alternatives and more info).
This mechanism works well when you control the content:
who authors it,
what tools handle it,
and where it’s displayed.
When authors can read a guide on how to embed a tweet but are not expected to
know the ins and outs of HTML or JavaScript.
Directives don’t work well if you don’t know who authors content,
what tools handle it,
and where it ends up.
Example use cases are a docs website for a project or product,
or blogging tools and static site generators.

If you just want to turn markdown into HTML (with maybe a few extensions such
as this one),
we recommend [micromark][github-micromark] with
[micromark-extension-directive][github-micromark-extension-directive] instead.
If you don’t use plugins and want to access the syntax tree,
you can use
[mdast-util-from-markdown][github-mdast-util-from-markdown] with
[mdast-util-directive][github-mdast-util-directive].

Install

This package is [ESM only][github-gist-esm].
In Node.js (version 16+),
install with [npm][npmjs-install]:

``sh
npm install remark-directive
`

In Deno with [esm.sh][esmsh]:

`js
import remarkDirective from 'https://esm.sh/remark-directive@3'
`

In browsers with [esm.sh][esmsh]:

`html

`

Use

Say our document example.md contains:

`markdown
:::main{#readme}

Lorem:br
ipsum.

::hr{.red}

A :i[lovely] language know as :abbr[HTML]{title="HyperText Markup Language"}.

:::
`

…and our module example.js contains:

`js
/**
* @import {} from 'mdast-util-directive'
* @import {} from 'mdast-util-to-hast'
* @import {Root} from 'mdast'
*/

import {h} from 'hastscript'
import rehypeFormat from 'rehype-format'
import rehypeStringify from 'rehype-stringify'
import remarkDirective from 'remark-directive'
import remarkParse from 'remark-parse'
import remarkRehype from 'remark-rehype'
import {read} from 'to-vfile'
import {unified} from 'unified'
import {visit} from 'unist-util-visit'

const file = await unified()
.use(remarkParse)
.use(remarkDirective)
.use(myRemarkPlugin)
.use(remarkRehype)
.use(rehypeFormat)
.use(rehypeStringify)
.process(await read('example.md'))

console.log(String(file))

// This plugin is an example to let users write HTML with directives.
// It’s informative but rather useless.
// See below for others examples.
function myRemarkPlugin() {
/**
* @param {Root} tree
* Tree.
* @returns {undefined}
* Nothing.
*/
return function (tree) {
visit(tree, function (node) {
if (
node.type === 'containerDirective' ||
node.type === 'leafDirective' ||
node.type === 'textDirective'
) {
const data = node.data || (node.data = {})
const hast = h(node.name, node.attributes || {})

data.hName = hast.tagName
data.hProperties = hast.properties
}
})
}
}
`

…then running node example.js yields:

`html


Lorem
ipsum.

---

A lovely language know as HTML.


`

API

This package exports no identifiers.
The default export is [remarkDirective][api-remark-directive].

$3

Add support for generic directives.

###### Parameters

* options
([Options][api-options], optional)
— configuration

###### Returns

Nothing (undefined).

###### Notes

Doesn’t handle the directives:
[create your own plugin][unifiedjs-create-remark-plugin] to do that.

$3

Configuration (TypeScript type).

###### Fields

* collapseEmptyAttributes
(boolean, default: true)
— collapse empty attributes: get title instead of title=""
* preferShortcut
(boolean, default: true)
— prefer # and . shortcuts for id and class
* preferUnquoted
(boolean, default: false)
— leave attributes unquoted if that results in less bytes
* quoteSmart
(boolean, default: false)
— use the other quote if that results in less bytes
* quote
('"' or "'",
default:
the [quote][github-remark-stringify-quote] used by remark-stringify for
titles)
— preferred quote to use around attribute values

Examples

$3

This example shows how directives can be used for YouTube embeds.
It’s based on the example in Use above.
If myRemarkPlugin was replaced with this function:

`js
/**
* @import {} from 'mdast-util-directive'
* @import {} from 'mdast-util-to-hast'
* @import {Root} from 'mdast'
* @import {VFile} from 'vfile'
*/

import {visit} from 'unist-util-visit'

// This plugin is an example to turn ::youtube into iframes.
function myRemarkPlugin() {
/**
* @param {Root} tree
* Tree.
* @param {VFile} file
* File.
* @returns {undefined}
* Nothing.
*/
return (tree, file) => {
visit(tree, function (node) {
if (
node.type === 'containerDirective' ||
node.type === 'leafDirective' ||
node.type === 'textDirective'
) {
if (node.name !== 'youtube') return

const data = node.data || (node.data = {})
const attributes = node.attributes || {}
const id = attributes.id

if (node.type === 'textDirective') {
file.fail(
'Unexpected :youtube text directive, use two colons for a leaf directive',
node
)
}

if (!id) {
file.fail('Unexpected missing id on youtube directive', node)
}

data.hName = 'iframe'
data.hProperties = {
src: 'https://www.youtube.com/embed/' + id,
width: 200,
height: 200,
frameBorder: 0,
allow: 'picture-in-picture',
allowFullScreen: true
}
}
})
}
}
`

…and example.md contains:

`markdown


Cat videos

::youtube[Video of a cat in a box]{#01ab2cd3efg}
`

…then running node example.js yields:

`html


Cat videos



`

$3

> 👉 Note:
> this is sometimes called admonitions, callouts, etc.

This example shows how directives can be used to style blocks.
It’s based on the example in Use above.
If myRemarkPlugin was replaced with this function:

`js
/**
* @import {} from 'mdast-util-directive'
* @import {} from 'mdast-util-to-hast'
* @import {Root} from 'mdast'
*/

import {h} from 'hastscript'
import {visit} from 'unist-util-visit'

// This plugin is an example to turn ::note into divs,
// passing arbitrary attributes.
function myRemarkPlugin() {
/**
* @param {Root} tree
* Tree.
* @returns {undefined}
* Nothing.
*/
return (tree) => {
visit(tree, (node) => {
if (
node.type === 'containerDirective' ||
node.type === 'leafDirective' ||
node.type === 'textDirective'
) {
if (node.name !== 'note') return

const data = node.data || (node.data = {})
const tagName = node.type === 'textDirective' ? 'span' : 'div'

data.hName = tagName
data.hProperties = h(tagName, node.attributes || {}).properties
}
})
}
}
`

…and example.md contains:

`markdown


How to use xxx

You can use xxx.

:::note{.warning}
if you chose xxx, you should also use yyy somewhere…
:::
`

…then running node example yields:

`html


How to use xxx

You can use xxx.

if you chose xxx, you should also use yyy somewhere…

`

Authoring

When authoring markdown with directives,
keep in mind that they don’t work in most places.
On your own site it can be great!

HTML

You can define how directives are turned into HTML.
If directives are not handled,
they do not emit anything.

CSS

How to display directives is left as an exercise for the reader.

Syntax

See Syntax in
micromark-extension-directive.

Syntax tree

See Syntax tree in
mdast-util-directive.

Types

This package is fully typed with [TypeScript][].
It exports no additional options.

If you’re working with the syntax tree,
you can register the new node types with @types/mdast by adding a reference:

`js
/**
* @import {} from 'mdast-util-directive'
* @import {Root} from 'mdast'
*/

import {visit} from 'unist-util-visit'

function myRemarkPlugin() {
/**
* @param {Root} tree
* Tree.
* @returns {undefined}
* Nothing.
*/
return (tree) => {
visit(tree, function (node) {
console.log(node) // node can now be one of the nodes for directives.
})
}
}
`

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-directive@3,
compatible with Node.js 16.

Security

Use of remark-directive does not involve [rehype][github-rehype]
([hast][github-hast])
or user content so there are no openings for
[cross-site scripting (XSS)][wikipedia-xss] attacks.

Related

* remark-gfm
— support GFM
(autolink literals, footnotes, strikethrough, tables, tasklists)
* remark-frontmatter
— support frontmatter
(YAML, TOML, and more)
* remark-math
— support math
* remark-mdx
— support MDX
(ESM, JSX, expressions)

Contribute

See [contributing.md][health-contributing]
in
[remarkjs/.github][health]
for ways to get started.
See [support.md`][health-support] for ways to get help.

This project has a [code of conduct][health-coc].
By interacting with this repository,
organization,
or community you agree to abide by its terms.

License

[MIT][file-license] © [Titus Wormer][wooorm]

[api-options]: #options

[api-remark-directive]: #unifieduseremarkdirective-options

[badge-build-image]: https://github.com/remarkjs/remark-directive/workflows/main/badge.svg

[badge-build-url]: https://github.com/remarkjs/remark-directive/actions

[badge-coverage-image]: https://img.shields.io/codecov/c/github/remarkjs/remark-directive.svg

[badge-coverage-url]: https://codecov.io/github/remarkjs/remark-directive

[badge-downloads-image]: https://img.shields.io/npm/dm/remark-directive.svg

[badge-downloads-url]: https://www.npmjs.com/package/remark-directive

[badge-size-image]: https://img.shields.io/bundlejs/size/remark-directive

[badge-size-url]: https://bundlejs.com/?q=remark-directive

[commonmark-directive-proposal]: https://talk.commonmark.org/t/generic-directives-plugins-syntax/444

[esmsh]: https://esm.sh

[file-license]: license

[github-gist-esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[github-hast]: https://github.com/syntax-tree/hast

[github-mdast-util-directive]: https://github.com/syntax-tree/mdast-util-directive

[github-mdast-util-from-markdown]: https://github.com/syntax-tree/mdast-util-from-markdown

[github-micromark]: https://github.com/micromark/micromark

[github-micromark-extending-markdown]: https://github.com/micromark/micromark#extending-markdown

[github-micromark-extension-directive]: https://github.com/micromark/micromark-extension-directive

[github-rehype]: https://github.com/rehypejs/rehype

[github-remark]: https://github.com/remarkjs/remark

[github-remark-stringify-quote]: https://github.com/remarkjs/remark/tree/main/packages/remark-stringify#options

[github-unified]: https://github.com/unifiedjs/unified

[health]: https://github.com/remarkjs/.github

[health-coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md

[health-contributing]: https://github.com/remarkjs/.github/blob/main/contributing.md

[health-support]: https://github.com/remarkjs/.github/blob/main/support.md

[npmjs-install]: https://docs.npmjs.com/cli/install

[typescript]: https://www.typescriptlang.org

[unifiedjs-create-remark-plugin]: https://unifiedjs.com/learn/guide/create-a-remark-plugin/

[wikipedia-xss]: https://en.wikipedia.org/wiki/Cross-site_scripting

[wooorm]: https://wooorm.com