• Stars
    star
    312
  • Rank 134,133 (Top 3 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created over 9 years ago
  • Updated about 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

plugin to add support for serializing HTML

remark-html

Build Coverage Downloads Size Sponsors Backers Chat

remark plugin to add support for serializing HTML.

Contents

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-rehype instead and finally use rehype-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 HTML, format HTML, highlight code, add metadata, and a lot more.

Install

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

npm install remark-html

In Deno with esm.sh:

import remarkHtml from 'https://esm.sh/remark-html@16'

In browsers with esm.sh:

<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 remarkHtml.

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

Serialize markdown as HTML.

Parameters
  • options (Options, optional) โ€” configuration
Returns

Transform (Transformer).

Notes

Passing sanitize: false is dangerous. It allows arbitrary HTML and does not sanitize elements.

Options

Configuration (TypeScript type).

Fields

Types

This package is fully typed with TypeScript. It exports the additional type 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) attacks. A safe schema is used by default, but passing an unsafe schema is unsafe.

Related

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

More Repositories

1

react-markdown

Markdown component for React
JavaScript
12,885
star
2

remark

markdown processor powered by plugins part of the @unifiedjs collective
JavaScript
7,513
star
3

remark-lint

plugins to check (lint) markdown code style
JavaScript
936
star
4

remark-gfm

remark plugin to support GFM (autolink literals, footnotes, strikethrough, tables, tasklists)
JavaScript
701
star
5

remark-react

Legacy plugin to transform to React โ€” please use `remark-rehype` and `rehype-react` instead
JavaScript
524
star
6

remark-toc

plugin to generate a table of contents (TOC)
JavaScript
408
star
7

awesome-remark

Curated list of awesome remark resources
374
star
8

remark-math

remark and rehype plugins to support math
JavaScript
364
star
9

remark-rehype

plugin that turns markdown into HTML to support rehype
JavaScript
258
star
10

remark-frontmatter

remark plugin to support frontmatter (YAML, TOML, and more)
JavaScript
253
star
11

remark-directive

remark plugin to support directives
JavaScript
247
star
12

react-remark

React component and hook to use remark to render markdown
TypeScript
201
star
13

remark-github

remark plugin to link references to commits, issues, pull-requests, and users, like on GitHub
JavaScript
173
star
14

strip-markdown

plugin remove Markdown formatting
JavaScript
134
star
15

remark-breaks

plugin to add break support, without needing spaces
JavaScript
116
star
16

remark-validate-links

plugin to check that Markdown links and images reference existing files and headings
JavaScript
109
star
17

remark-man

plugin to compile markdown to man pages
JavaScript
93
star
18

remark-slug

Legacy plugin to add `id`s to headings โ€” please use `rehype-slug`
JavaScript
89
star
19

remark-lint-no-dead-urls

Ensure that external links in your Markdown are alive
JavaScript
77
star
20

remark-unwrap-images

plugin to remove the wrapping paragraph for images
JavaScript
75
star
21

remark-highlight.js

Legacy plugin to highlight code blocks with highlight.js โ€” please use `rehype-highlight` instead
JavaScript
70
star
22

remark-autolink-headings

Legacy remark plugin to automatically add links to headings โ€” please use `rehype-autolink-headings` instead
JavaScript
64
star
23

remark-external-links

Legacy plugin to automatically add target and rel attributes to external links โ€” please use `rehype-external-links` instead
JavaScript
56
star
24

vscode-remark

Lint and format markdown code with remark
JavaScript
54
star
25

remark-vdom

Legacy plugin to compile Markdown to Virtual DOM โ€” please use `remark-rehype` and then something like `rehype-react`
JavaScript
45
star
26

remark-usage

plugin to add a usage example to your readme
JavaScript
42
star
27

remark-gemoji

plugin to turn gemoji shortcodes into emoji ๐Ÿ‘
JavaScript
41
star
28

remark-footnotes

Legacy plugin to add support for pandoc footnotes โ€” please use `remark-gfm` instead
JavaScript
40
star
29

remark-images

plugin to add a simpler image syntax
JavaScript
35
star
30

remark-textr

plugin to make your typography better with Textr
JavaScript
35
star
31

remark-language-server

A language server to lint and format markdown files with remark
JavaScript
33
star
32

remark-embed-images

plugin to embed local images as data URIs
HTML
33
star
33

remark-jsx

A simple way to use React inside Markdown.
JavaScript
28
star
34

remark-reference-links

plugin to change links and images to references with separate definitions
JavaScript
25
star
35

remark-retext

plugin to transform from remark (Markdown) to retext (natural language)
JavaScript
25
star
36

remark-inline-links

plugin to change references and definitions into normal links and images
JavaScript
23
star
37

remark-contributors

plugin to generate a list of contributors
JavaScript
22
star
38

remark-license

plugin to generate a license section
JavaScript
19
star
39

remark-defsplit

plugin to change links and images to references with separate definitions
JavaScript
19
star
40

remark-bookmarks

plugin to manage links
JavaScript
15
star
41

remark-comment-config

plugin to configure remark with comments
JavaScript
14
star
42

remark-git-contributors

plugin to generate a list of Git contributors
JavaScript
12
star
43

remark-normalize-headings

plugin to make sure there is a single top level heading in a document by adjusting heading ranks accordingly
JavaScript
11
star
44

remark-squeeze-paragraphs

plugin to remove empty (or white-space only) paragraphs
JavaScript
10
star
45

remark-strip-badges

plugin to strip badges (such as shields.io)
JavaScript
9
star
46

gulp-remark

Legacy Gulp plugin for remark โ€” please use npm scripts and the like
JavaScript
9
star
47

remark-yaml-config

plugin to configure remark with YAML frontmatter
JavaScript
8
star
48

remark-message-control

plugin to enable, disable, and ignore messages
JavaScript
8
star
49

.github

Community health files for remark
TypeScript
7
star
50

remark-unlink

plugin to remove all links, images, references, and definitions
JavaScript
6
star
51

remark-heading-gap

plugin to adjust the gap between headings in markdown
JavaScript
6
star
52

ideas

Share ideas for new utilities and tools built with @remarkjs
5
star
53

remark-word-wrap

Please use something like https://github.com/prettier/prettier instead
JavaScript
4
star
54

grunt-remark

Grunt task for remark
4
star
55

remark-midas

plugin to highlight CSS code blocks with midas
3
star
56

remark-comment-blocks

Use something like https://github.com/3rd-Eden/commenting instead
JavaScript
2
star
57

governance

How @remarkjs and the projects under it are governed
2
star