https://github.com/zuchka/remove-markdown

Strip Markdown stuff from text
https://github.com/zuchka/remove-markdown

javascript markdown nodejs

Last synced: 2 months ago
JSON representation

Strip Markdown stuff from text

• Host: GitHub
• URL: https://github.com/zuchka/remove-markdown
• Owner: zuchka
• License: mit
• Created: 2015-02-15T06:59:23.000Z (almost 10 years ago)
• Default Branch: main
• Last Pushed: 2024-09-01T04:44:40.000Z (4 months ago)
• Last Synced: 2024-10-29T15:39:26.480Z (2 months ago)
• Topics: javascript, markdown, nodejs
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/remove-markdown
• Size: 106 KB
• Stars: 309
• Watchers: 5
• Forks: 62
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-nodejs - remove-markdown - Strip Markdown stuff from text.  (Repository / Parsing)
• project-awesome - zuchka/remove-markdown - Strip Markdown stuff from text (JavaScript)

README

        
- ![default workflow](https://github.com/stiang/remove-markdown/actions/workflows/default.yaml/badge.svg)

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

```js

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:

```js

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](http://brettterpstra.com/2013/10/18/a-markdown-service-to-strip-markdown/) by Brett Terpstra.

## Authors

Stian Grytøyr (original creator)

[zuchka](https://github.com/zuchka) (maintainer since 2023)