Package Exports
- remove-markdown
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (remove-markdown) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
What is it?
remove-markdown is a node.js module that will remove (strip) Markdown formatting from a text. "Markdown formatting" means pretty much anything that doesn’t look like regular text, like square brackets, asterisks etc.
When do I need it?
The typical use case is to display an excerpt of a Markdown text, without the actual Markdown (or rendered HTML, for that matter), for example in a list of posts.
Installation
npm install remove-markdownUsage
var removeMd = require('remove-markdown');
var markdown = '# This is a heading\n\nThis is a paragraph with [a link](http://www.disney.com/) in it.';
var plainText = removeMd(markdown); // plainText is now 'This is a heading\n\nThis is a paragraph with a link in it.'You can also supply an options object to the function. Currently, the only two options are for stripping list headers and supporting Github Flavored Markdown:
var plainText = removeMd(markdown, {
stripListLeaders: false,
gfm: false
}); // The default for both is trueStripping list headers will retain any list characters (*, -, +, (digit).).
Credits
The code is based on Markdown Service Tools - Strip Markdown by Brett Terpstra.
Author
Stian Grytøyr