micro-down

JavaScript based Markdown parser without dependencies.

1.4kB markdown parser (minified + gzipped)

check out this demo

npm install -S micro-down

usage

micro-down exports 4 functions, although you mostly want to use parse.

parse turns the full markdown into html

const result = markdown.parse('_this_ is **MARKDOWN**');

inline replaces only the inline markup. (bold,italic,underline,strike-trough,line-breaks); inlineBlock transforms only inline code blocks ands media block handles everything else, see below.

As a second parameter you can pass an options object: | option | type | default | description | |---|---|---|---| | preCode | boolean | false | wrap pre blocks ``` in <pre><code>

support:

• Headlines: ### Headline
• Inline:
  • *italic*, **bold**, ***bold italic***
  • `_code_="- something";` or direct escaping with \
  • ~underline~, ~~strike through~~, ~~~deleted~~~
• Blocks:
  • pre format blocks: surrounded by ```
  • div blocks: """ just a div block """
  • blockquotes: > something
  • class support
• Anchors: #[jump-here]
• Links: [Label](destination Title)
  • URL auto linking https://github.com/coding-intl/micro-down
• Images: ![label](source altText))
  • linked: [![label](source altText))](destination Title)
• IFrames: &[class](url) &[width,height,frame class](url)
• Lists:
  • Unordered lists using: + and -
  • Ordered lists using: 1.
  • Nested lists
• Tables: | some | text |
  • Header row: |- header -|- row -| or by a following |---
• Comments <!-- # Comment -->