remark-html

remark plugin to compile Markdown to HTML

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
remark-html
306016.0.19 months ago8 years agoMinified + gzip package size for remark-html in KB

Readme

remark-html
!Buildbuild-badgebuild !Coveragecoverage-badgecoverage !Downloadsdownloads-badgedownloads !Sizesize-badgesize !Sponsorssponsors-badgecollective !Backersbackers-badgecollective !Chatchat-badgechat
remark plugin to add support for serializing HTML.

Contents

*   [`unified().use(remarkHtml[, options])`](#unifieduseremarkhtml-options)
*   [`Options`](#options)

What is this?

This package is a unified
(remark) plugin that compiles markdown to HTML.

When should I use this?

This plugin is useful when you want to turn markdown into HTML. It’s a shortcut for .use(remarkRehype).use(rehypeSanitize).use(rehypeStringify).
The reason that there are different ecosystems for markdown and HTML is that turning markdown into HTML is, while frequently needed, not the only purpose of markdown. Checking (linting) and formatting markdown are also common use cases for remark and markdown. There are several aspects of markdown that do not translate 1-to-1 to HTML. In some cases markdown contains more information than HTML: for example, there are several ways to add a link in markdown (as in, autolinks: <https://url>, resource links: [label](url), and reference links with definitions: [label][id] and [id]: url). In other cases HTML contains more information than markdown: there are many tags, which add new meaning (semantics), available in HTML that aren’t available in markdown. If there was just one AST, it would be quite hard to perform the tasks that several remark and rehype plugins currently do.
This plugin is useful when you want to quickly turn markdown into HTML. In most cases though, it’s recommended to use remark-rehyperemark-rehype instead and finally use rehype-stringifyrehype-stringify to serialize HTML. The reason using both ecosystems instead of this plugin is recommended, is that there are many useful rehype plugins that you can then use. For example, you can minify HTMLrehype-minify, format HTMLrehype-format, highlight coderehype-highlight, add metadatarehype-meta, and a lot more.

Install

This package is ESM onlyesm. In Node.js (version 16+), install with npm:
npm install remark-html

In Deno with esm.shesmsh:
import remarkHtml from 'https://esm.sh/remark-html@16'

In browsers with esm.shesmsh:
<script type="module">
  import remarkHtml from 'https://esm.sh/remark-html@16?bundle'
</script>

Use

Say we have the following file example.md:
# Pluto

**Pluto** (minor-planet designation: **134340 Pluto**) is a
[dwarf planet](https://en.wikipedia.org/wiki/Dwarf_planet) in the
[Kuiper belt](https://en.wikipedia.org/wiki/Kuiper_belt).

…and a module example.js:
import remarkHtml from 'remark-html'
import remarkParse from 'remark-parse'
import {read} from 'to-vfile'
import {unified} from 'unified'

const file = await unified()
  .use(remarkParse)
  .use(remarkHtml)
  .process(await read('example.md'))

console.log(String(file))

…then running node example.js yields:
<h1>Pluto</h1>
<p><strong>Pluto</strong> (minor-planet designation: <strong>134340 Pluto</strong>) is a
<a href="https://en.wikipedia.org/wiki/Dwarf_planet">dwarf planet</a> in the
<a href="https://en.wikipedia.org/wiki/Kuiper_belt">Kuiper belt</a>.</p>

API

This package exports no identifiers. The default export is remarkHtmlapi-remark-html.

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

Serialize markdown as HTML.
Parameters
— configuration
Returns
Transform (Transformerunified-transformer).
Notes
Passing sanitize: false is dangerous. It allows arbitrary HTML and does not sanitize elements.

Options

Configuration (TypeScript type).
Fields
`mdast-util-to-hast`][mdast-util-to-hast-handlers], optional)
— how to turn mdast nodes into hast nodes
`hast-util-sanitize`][hast-util-sanitize-schema] or `boolean`, default:
`true`)
— sanitize the output, and how
`hast-util-to-html`][hast-util-to-html-options], optional)
— other options are passed to `hast-util-to-html`

Types

This package is fully typed with TypeScript. It exports the additional type Optionsapi-options.

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-html@^16, compatible with Node.js 16.
This plugin works with unified version 6+ and remark version 15+.

Security

Use of remark-html is safe by default. Passing sanitize: false is unsafe and opens you up to cross-site scripting (XSS)wiki-xss attacks. A safe schema is used by default, but passing an unsafe schema is unsafe.

Related

— turn markdown into HTML to support rehype
— sanitize HTML

Contribute

See contributing.mdcontributing in remarkjs/.githubhealth for ways to get started. See support.mdsupport for ways to get help.
This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MITlicense © Titus Wormerauthor