@platzi/markdown

Platzi Flavored Markdown

This is the markdown parser used in the Platzi education platform editor.

This version of Markdown support the usual Github Flavored Markdown and Youtube videos, emojis, figure wrapping images, <mark /> tags, underlines, abbr and definition lists.

How use it

Install it with npm.

npm i -S @platzi/markdown

Import it in your project.

import createParser from '@platzi/markdown';

And the use it.

const parser = createParser();
const html = parser(`**this is my text in bold**`);

Contribute

• Fork the project.
• Modify index.js.
• Run tests npm t.
• Fix problems (or the test).

Example Markdown

![Platzi Logo](https://static.platzi.com/static/images/logos/[e-mail])

*[HTML]: Hyper Text Markup Language
*[W3C]:  World Wide Web Consortium

# Heading 1
Lorem **ipsum** dolor _sit_ ++amet++ :D.

The HTML ==specification== is maintained by the W3C.

- item 1
- item 2
- item 3

Term 1
  ~ Definition 1

Term 2
  ~ Definition 2a
  ~ Definition 2b

@[youtube](ajLJOhf-WdA)