JavaScript pure implementation of GitHub Flavored Markdown (GFM) specification.
- ✅ %100 Specification compliance
- 🚫 No dependencies
- 🚀 Works in Node.js, and Browser
NOTE: I haven't published the npm package yet. It will automatically get published by Travis when all spec tests are passing
$ npm add --save gfmc
import gfmc from('gfmc')
const markdown = '# This is title '
console.log(gfmc(markdown))
// =>
// <h1>This is title</h1>
gfmc(src: string, options: Object)
Option | Description |
---|---|
renderer {Object} | A custom Renderer to be used by the Parser (default: HTMLRenderer) |
The project is still in active development and currently doesn't support:
- Fenced code blocks
- HTML blocks
- Link reference definitions
- Tables
- Block quotes
- Lists
- Task lists
- Backslash escapes
- Code spans
- Emphasis and strong emphasis
- Strikethrough
- Links
- Images
- Autolinks
- Raw HTML
- Hard line breaks
- Soft line breaks
- Textual content
Thanks goes to these wonderful people (emoji key):
Ahmed T. Ali 📝 💻 📖 |
Ashe Connor 💬 |
---|
This project follows the all-contributors specification. Contributions of any kind welcome!
We use SemVer for versioning. For the versions available, see the tags on this repository.
Give it a star(⭐️) 👆
MIT © Ahmed T. Ali