*** 2022-10-18: Important message about the future of this package ***
Hello all, I don’t use this package in my own projects any longer and I have come to the realization that I basically don’t have the bandwidth to maintain the package.
However, the package is used quite a bit and I don’t want to just abandon it. So I’m looking for suggestions on how to move forward with someone else in charge of maintaining the package on a day-to-day basis. I’m open to adding collaborators to this repo or moving the entire repo to a more fitting home.
Please contact me directly or post a comment on the issue I created about this (#61).
What is it?
remove-markdown is a node.js module that will remove (strip) Markdown formatting from 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 from some Markdown text, without any of the actual Markdown syntax - for example in a list of posts.
Installation
npm install remove-markdown
Usage
const removeMd = require('remove-markdown');
const markdown = '# This is a heading\n\nThis is a paragraph with [a link](http://www.disney.com/) in it.';
const 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 following options are supported:
const plainText = removeMd(markdown, {
stripListLeaders: true , // strip list leaders (default: true)
listUnicodeChar: '', // char to insert instead of stripped list leaders (default: '')
gfm: true // support GitHub-Flavored Markdown (default: true)
useImgAltText: true // replace images with alt-text, if present (default: true)
});Setting stripListLeaders to false will retain any list characters (*, -, +, (digit).).
TODO
PRs are very much welcome. Here are some ideas for future enhancements:
- Allow the RegEx expressions to be customized per rule
- Make the rules more robust, support more edge cases
- Add more (comprehensive) tests
Credits
The code is based on Markdown Service Tools - Strip Markdown by Brett Terpstra.
Author
Stian Grytøyr