markdown-escapes
Advanced tools
Package description
The markdown-escapes package is designed to help with escaping and unescaping characters in Markdown text. It provides a straightforward API for handling characters that have special meanings in Markdown syntax, making it easier to work with Markdown programmatically. This can be particularly useful when generating Markdown content dynamically or when processing and sanitizing user-generated Markdown content.
Escaping Markdown characters
This feature allows you to escape special Markdown characters in a string, preventing them from being interpreted as Markdown syntax. This is useful when you want to display these characters as plain text in a Markdown document.
const markdownEscapes = require('markdown-escapes');
const text = 'Markdown *text* with special characters';
const escapedText = markdownEscapes.escape(text);
console.log(escapedText);Unescaping Markdown characters
This feature enables you to unescape previously escaped Markdown characters in a string, allowing them to be interpreted as Markdown syntax again. This can be useful when processing or transforming Markdown content that has been escaped for storage or transmission.
const markdownEscapes = require('markdown-escapes');
const escapedText = 'Markdown \*text\* with special characters';
const unescapedText = markdownEscapes.unescape(escapedText);
console.log(unescapedText);markdown-it is a powerful Markdown parser and renderer. While it focuses more on converting Markdown into HTML, it also offers a range of plugins that can handle escaping and unescaping of Markdown content, among other functionalities. Compared to markdown-escapes, markdown-it provides a broader set of features for working with Markdown, making it suitable for more complex Markdown processing tasks.
remarkable is another comprehensive Markdown parser that supports a wide range of Markdown extensions and features. It includes capabilities for escaping special characters in Markdown, similar to markdown-escapes, but also offers a full suite of Markdown processing tools, including parsing, rendering, and plugin support. This makes remarkable a more versatile option for users who need more than just character escaping.
Readme
List of escapable characters in markdown.
npm:
npm install markdown-escapes
var escapes = require('markdown-escapes');
// Access by property:
escapes.commonmark; //=> ['\\', '`', ..., '@', '^']
// Access by options object:
escapes({gfm: true}); //=> ['\\', '`', ..., '~', '|']
escapes([options])Get escapes. Supports options.commonmark and options.gfm, which
when true returns the extra escape characters supported by those
flavours.
Array.<string>.
escapes.defaultList of default escapable characters.
escapes.gfmList of escapable characters in GFM (which includes all defaults).
escapes.commonmarkList of escapable characters in CommonMark (which includes all gfms).
FAQs
Legacy list of escapable characters in markdown
The npm package markdown-escapes receives a total of 1,890,016 weekly downloads. As such, markdown-escapes popularity was classified as popular.
We found that markdown-escapes demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.