https://github.com/platzidev/markdown

Platzi Flavored Markdown parser
https://github.com/platzidev/markdown

javascript markdown markdown-parser node npm

Last synced: 2 months ago
JSON representation

Platzi Flavored Markdown parser

• Host: GitHub
• URL: https://github.com/platzidev/markdown
• Owner: PlatziDev
• License: mit
• Created: 2017-01-13T00:08:16.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-11-28T02:48:02.000Z (about 1 year ago)
• Last Synced: 2024-10-28T12:53:38.030Z (2 months ago)
• Topics: javascript, markdown, markdown-parser, node, npm
• Language: JavaScript
• Size: 96.7 KB
• Stars: 8
• Watchers: 56
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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, `` tags, underlines, abbr and definition lists.

## How use it

Install it with **npm**.

```bash

npm i -S @platzi/markdown

```

Import it in your project.

```js

import createParser from '@platzi/markdown';

```

And the use it.

```js

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

```markdown

![Platzi Logo](https://static.platzi.com/static/images/logos/[email protected])

*[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)

```