README.md

html-to-formatted-text

What

Converts HTML to formatted plain text.

From:

"<p>Some text.</p><p>More text.</p><div>Even more text.</div>"

To:

Some text.

More text.

Even more text.

Usage

Node

Installation

npm install --save html-to-formatted-text

const htmlToFormattedText = require("html-to-formatted-text");
htmlToFormattedText("<p>foo</p><p>bar</p>");
/* Output
"foo
bar"
*/

ES6

// ES6
import htmlToFormattedText from "html-to-formatted-text";
htmlToFormattedText("<p>foo</p><p>bar</p>");
/* Output
"foo
bar"
*/

Vanilla JS / UMD

<!-- latest version -->
<script src="https://unpkg.com/html-to-formatted-text/dist/index.umd.min.js"></script>
<!-- or for a specific version -->
<script src="https://unpkg.com/[email protected]/dist/index.umd.min.js"></script>
<script>
  document.addEventListener("DOMContentLoaded", function () {
    window.htmlToFormattedText('<p>foo</p><p>bar</p>')
    /* Output
    "foo
    bar"
    */
  });
</script>

Why

You might have HTML that you want to display as text.

One use case might be that a user adds HTML via an online editor TinyMCE and you want to display this as plain text somewhere else.

Contributing

• Create an issue on Github
• Fork project
• Make changes then use npm run commit to make commits
• Create a pull request