Home
Docs
GitHub
Pricing
Blog
Log In

Run Sandworm Audit for your App

Get started
Hold on, we're currently generating a fresh version of this report
Generated on May 17, 2024 via pnpm

remark-parse 10.0.0

remark plugin to parse markdown
Package summary
Share
0
issues
2
licenses
46
MIT
1
BSD-3-Clause
Package created
12 Jun 2016
Version published
3 Aug 2021
Maintainers
3
Total deps
47
Direct deps
3
License
MIT

Issues

0
This package has no issues

Licenses

MIT License

Permissive
OSI Approved
This is a human-readable summary of (and not a substitute for) the license. Disclaimer.
Can
commercial-use
modify
distribute
sublicense
private-use
Cannot
hold-liable
Must
include-copyright
include-license
46 Packages, Including:
@types/debug@4.1.12
@types/mdast@3.0.15
@types/ms@0.7.34
@types/unist@2.0.10
bail@2.0.2
character-entities@2.0.2
debug@4.3.4
decode-named-character-reference@1.0.2
dequal@2.0.3
extend@3.0.2
is-buffer@2.0.5
is-plain-obj@4.1.0
kleur@4.1.5
mdast-util-from-markdown@1.3.1
mdast-util-to-string@3.2.0
micromark-core-commonmark@1.1.0
micromark-factory-destination@1.1.0
micromark-factory-label@1.1.0
micromark-factory-space@1.1.0
micromark-factory-title@1.1.0
micromark-factory-whitespace@1.1.0
micromark-util-character@1.2.0
micromark-util-chunked@1.1.0
micromark-util-classify-character@1.1.0
micromark-util-combine-extensions@1.1.0
micromark-util-decode-numeric-character-reference@1.1.0
micromark-util-decode-string@1.1.0
micromark-util-encode@1.1.0
micromark-util-html-tag-name@1.2.0
micromark-util-normalize-identifier@1.1.0
micromark-util-resolve-all@1.1.0
micromark-util-sanitize-uri@1.2.0
micromark-util-subtokenize@1.1.0
micromark-util-symbol@1.1.0
micromark-util-types@1.1.0
micromark@3.2.0
mri@1.2.0
ms@2.1.2
remark-parse@10.0.0
sade@1.8.1
trough@2.2.0
unified@10.1.2
unist-util-stringify-position@3.0.3
uvu@0.5.6
vfile-message@3.1.4
vfile@5.3.7

BSD 3-Clause "New" or "Revised" License

Permissive
OSI Approved
This is a human-readable summary of (and not a substitute for) the license. Disclaimer.
Can
commercial-use
modify
distribute
place-warranty
Cannot
use-trademark
hold-liable
Must
include-copyright
include-license
1 Packages, Including:
diff@5.2.0
Disclaimer

This deed highlights only some of the key features and terms of the actual license. It is not a license and has no legal value. You should carefully review all of the terms and conditions of the actual license before using the licensed material.

Sandworm is not a law firm and does not provide legal services. Distributing, displaying, or linking to this deed or the license that it summarizes does not create a lawyer-client or any other relationship.

Direct Dependencies

3
All Dependencies CSV
β“˜ This is a list of remark-parse 's direct dependencies. Data on all dependencies, including transitive ones, is available via CSV download.
NameVersionSizeLicenseTypeVulnerabilities
@types/mdast3.0.153.12 kBMIT
prod
mdast-util-from-markdown1.3.121.44 kBMIT
prod
unified10.1.220 kBMIT
prod

Visualizations

Frequently Asked Questions

What does remark-parse do?

Remark-parse is a highly capable JavaScript plugin for the unified system and part of the Remark ecosystem. It enhances unified by facilitating markdown parsing and transforming it into a syntax tree. This allows developers to handle markdown content flexibly and employ syntax extensions to add advanced features.

How do you use remark-parse?

To install and use remark-parse, follow these steps:

  1. Install remark-parse using npm (Node.js 16 or higher required):
npm install remark-parse
  1. Import and use it within your JavaScript code.

Here's an example :

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))

Running this script will transform your markdown into HTML.

Where are the remark-parse docs?

The official documentation of remark-parse can be found on GitHub at https://github.com/remarkjs/remark/tree/main/packages/remark-parse. The repository's README file provides a detailed explanation about the plugin and its usage. Its vast ecosystem, along with the plethora of examples provided, make it an instrumental tool in markdown handling.