Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

markdown-to-text

danestves58.4kMIT0.1.1TypeScript support: included

Parse the markdown and returns a string

markdown, text, ts

readme

Welcome to markdown-to-text 👋

Version npm CircleCI License: MIT Twitter: danestves

Parse the markdown and returns a string

Install

# npm
npm install markdown-to-text

# yarn
yarn add markdown-to-text

Usage

// ES5
const removeMarkdown = require("markdown-to-text");
// Or in ES6
import removeMarkdown from "markdown-to-text";

const markdown =
  "*Javascript* [developers](https://engineering.condenast.io/) are the _best_.";
removeMarkdown(markdown);

// It will render to
// Javascript developers are the best.

Author

👤 Daniel Esteves

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2020 Daniel Esteves.
This project is MIT licensed.


This README was generated with ❤️ by readme-md-generator

changelog

Changelog

key

Changelog entries are classified using the following labels (from keep-a-changelog):

  • added: for new features
  • changed: for changes in existing functionality
  • deprecated: for once-stable features removed in upcoming releases
  • removed: for deprecated features removed in this release
  • fixed: for any bug fixes

[0.1.1] - 2020-12-13

Added

  • Circle CI to tests

Changed

  • TypeScript version to latest

[0.1.0] - 2020-12-13

Added

  • removeMarkdown to parse the markdown and covert it to string
  • Integrate TS for the project