# remark-parse [![Build][build-badge]][build] [![Coverage][coverage-badge]][coverage] [![Downloads][downloads-badge]][downloads] [![Size][size-badge]][size] [![Sponsors][sponsors-badge]][collective] [![Backers][backers-badge]][collective] [![Chat][chat-badge]][chat] **[remark][]** plugin to add support for parsing from markdown. ## Contents * [What is this?](#what-is-this) * [When should I use this?](#when-should-i-use-this) * [Install](#install) * [Use](#use) * [API](#api) * [`unified().use(remarkParse)`](#unifieduseremarkparse) * [Examples](#examples) * [Example: support GFM and frontmatter](#example-support-gfm-and-frontmatter) * [Example: turning markdown into a man page](#example-turning-markdown-into-a-man-page) * [Syntax](#syntax) * [Syntax tree](#syntax-tree) * [Types](#types) * [Compatibility](#compatibility) * [Security](#security) * [Contribute](#contribute) * [Sponsor](#sponsor) * [License](#license) ## What is this? This package is a [unified][] ([remark][]) plugin that defines how to take markdown as input and turn it into a syntax tree. See [the monorepo readme][remark] for info on what the remark ecosystem is. ## When should I use this? This plugin adds support to unified for parsing markdown. If you also need to serialize markdown, you can alternatively use [`remark`][remark-core], which combines unified, this plugin, and [`remark-stringify`][remark-stringify]. If you *just* want to turn markdown into HTML (with maybe a few extensions), we recommend [`micromark`][micromark] instead. If you don’t use plugins and want to access the syntax tree, you can directly use [`mdast-util-from-markdown`][mdast-util-from-markdown]. remark focusses on making it easier to transform content by abstracting these internals away. You can combine this plugin with other plugins to add syntax extensions. Notable examples that deeply integrate with it are [`remark-gfm`][remark-gfm], [`remark-mdx`][remark-mdx], [`remark-frontmatter`][remark-frontmatter], [`remark-math`][remark-math], and [`remark-directive`][remark-directive]. You can also use any other [remark plugin][remark-plugin] after `remark-parse`. ## Install This package is [ESM only][esm]. In Node.js (version 16+), install with [npm][]: ```sh npm install remark-parse ``` In Deno with [`esm.sh`][esmsh]: ```js import remarkParse from 'https://esm.sh/remark-parse@11' ``` In browsers with [`esm.sh`][esmsh]: ```html ``` ## Use Say we have the following module `example.js`: ```js import rehypeStringify from 'rehype-stringify' import remarkGfm from 'remark-gfm' import remarkParse from 'remark-parse' import remarkRehype from 'remark-rehype' import {unified} from 'unified' const doc = ` # Mercury **Mercury** is the first planet from the [Sun](https://en.wikipedia.org/wiki/Sun) and the smallest planet in the Solar System. ` const file = await unified() .use(remarkParse) .use(remarkGfm) .use(remarkRehype) .use(rehypeStringify) .process(doc) console.log(String(file)) ``` …then running `node example.js` yields: ```html

Mercury

Mercury is the first planet from the Sun and the smallest planet in the Solar System.

``` ## API This package exports no identifiers. The default export is [`remarkParse`][api-remark-parse]. ### `unified().use(remarkParse)` Add support for parsing from markdown. ###### Parameters There are no parameters. ###### Returns Nothing (`undefined`). ## Examples ### Example: support GFM and frontmatter We support CommonMark by default. Non-standard markdown extensions can be enabled with plugins. This example shows how to support GFM features (autolink literals, footnotes, strikethrough, tables, tasklists) and frontmatter (YAML): ```js import rehypeStringify from 'rehype-stringify' import remarkFrontmatter from 'remark-frontmatter' import remarkGfm from 'remark-gfm' import remarkParse from 'remark-parse' import remarkRehype from 'remark-rehype' import {unified} from 'unified' const doc = `--- layout: solar-system --- # Hi ~~Mars~~Venus! ` const file = await unified() .use(remarkParse) .use(remarkFrontmatter) .use(remarkGfm) .use(remarkRehype) .use(rehypeStringify) .process(doc) console.log(String(file)) ``` Yields: ```html

Hi MarsVenus!

``` ### Example: turning markdown into a man page Man pages (short for manual pages) are a way to document CLIs (example: type `man git-log` in your terminal). They use an old markup format called roff. There’s a remark plugin, [`remark-man`][remark-man], that can serialize as roff. This example shows how to turn markdown into man pages by using unified with `remark-parse` and `remark-man`: ```js import remarkMan from 'remark-man' import remarkParse from 'remark-parse' import {unified} from 'unified' const doc = ` # titan(7) -- largest moon of saturn Titan is the largest moon… ` const file = await unified().use(remarkParse).use(remarkMan).process(doc) console.log(String(file)) ``` Yields: ```roff .TH "TITAN" "7" "September 2023" "" "" .SH "NAME" \fBtitan\fR - largest moon of saturn .P Titan is the largest moon… ``` ## Syntax Markdown is parsed according to CommonMark. Other plugins can add support for syntax extensions. If you’re interested in extending markdown, [more information is available in micromark’s readme][micromark-extend]. ## Syntax tree The syntax tree used in remark is [mdast][]. ## Types This package is fully typed with [TypeScript][]. It exports the additional type `Options` (which is currently empty). ## 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-parse@^11`, compatible with Node.js 16. ## Security As markdown can be turned into HTML and improper use of HTML can open you up to [cross-site scripting (XSS)][xss] attacks, use of remark can be unsafe. When going to HTML, you will combine remark with **[rehype][]**, in which case you should use [`rehype-sanitize`][rehype-sanitize]. Use of remark plugins could also open you up to other attacks. Carefully assess each plugin and the risks involved in using them. For info on how to submit a report, see our [security policy][security]. ## Contribute See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways to get started. See [`support.md`][support] for ways to get help. Join us in [Discussions][chat] to chat with the community and contributors. This project has a [code of conduct][coc]. By interacting with this repository, organization, or community you agree to abide by its terms. ## Sponsor Support this effort and give back by sponsoring on [OpenCollective][collective]!

Vercel	Motif		HashiCorp		GitBook		Gatsby

Netlify	Coinbase	ThemeIsle	Expo	Boost Note	Markdown Space	Holloway
	You?

## License [MIT][license] © [Titus Wormer][author] [build-badge]: https://github.com/remarkjs/remark/workflows/main/badge.svg [build]: https://github.com/remarkjs/remark/actions [coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark.svg [coverage]: https://codecov.io/github/remarkjs/remark [downloads-badge]: https://img.shields.io/npm/dm/remark-parse.svg [downloads]: https://www.npmjs.com/package/remark-parse [size-badge]: https://img.shields.io/bundlejs/size/remark-parse [size]: https://bundlejs.com/?q=remark-parse [sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg [backers-badge]: https://opencollective.com/unified/backers/badge.svg [collective]: https://opencollective.com/unified [chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg [chat]: https://github.com/remarkjs/remark/discussions [security]: https://github.com/remarkjs/.github/blob/main/security.md [health]: https://github.com/remarkjs/.github [contributing]: https://github.com/remarkjs/.github/blob/main/contributing.md [support]: https://github.com/remarkjs/.github/blob/main/support.md [coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md [license]: https://github.com/remarkjs/remark/blob/main/license [author]: https://wooorm.com [npm]: https://docs.npmjs.com/cli/install [esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c [esmsh]: https://esm.sh [mdast]: https://github.com/syntax-tree/mdast [mdast-util-from-markdown]: https://github.com/syntax-tree/mdast-util-from-markdown [micromark]: https://github.com/micromark/micromark [micromark-extend]: https://github.com/micromark/micromark#extensions [rehype]: https://github.com/rehypejs/rehype [rehype-sanitize]: https://github.com/rehypejs/rehype-sanitize [remark]: https://github.com/remarkjs/remark [remark-core]: ../remark/ [remark-directive]: https://github.com/remarkjs/remark-directive [remark-frontmatter]: https://github.com/remarkjs/remark-frontmatter [remark-gfm]: https://github.com/remarkjs/remark-gfm [remark-mdx]: https://github.com/mdx-js/mdx/tree/main/packages/remark-mdx [remark-man]: https://github.com/remarkjs/remark-man [remark-math]: https://github.com/remarkjs/remark-math [remark-plugin]: https://github.com/remarkjs/remark#plugin [remark-stringify]: ../remark-stringify/ [typescript]: https://www.typescriptlang.org [unified]: https://github.com/unifiedjs/unified [xss]: https://en.wikipedia.org/wiki/Cross-site_scripting [api-remark-parse]: #unifieduseremarkparse

Paquete	Descargas	Stars	Tamaño	Issues	Publicación	Licencia

remark-parse	13,763,622	8,501	19.5 kB	2	hace 2 años	MIT