markdown-it-incremental-dom

2.0.1 • Public • Published

markdown-it-incremental-dom

Travis CI Coveralls npm LICENSE

A markdown-it renderer plugin by using Incremental DOM.

Let's see key features: https://yhatt.github.io/markdown-it-incremental-dom/ or docs.md

Requirement

Examples

Node.js

const IncrementalDOM = require('incremental-dom')
 
const md = require('markdown-it')().use(
  require('markdown-it-incremental-dom'),
  IncrementalDOM
)
 
IncrementalDOM.patch(
  document.getElementById('target'),
  md.renderToIncrementalDOM('# Hello, Incremental DOM!')
)

Browser

Define as window.markdownitIncrementalDOM.

<!DOCTYPE HTML>
<html>
<head>
  <script src="https://ajax.googleapis.com/ajax/libs/incrementaldom/0.5.1/incremental-dom-min.js"></script> 
  <script src="https://cdn.jsdelivr.net/npm/markdown-it@8.4.0/dist/markdown-it.min.js"></script> 
  <script src="./node_modules/markdown-it-incremental-dom/dist/markdown-it-incremental-dom.min.js"></script> 
</head>
<body>
  <div id="target"></div>
 
  <script>
    var md = new markdownit().use(markdownitIncrementalDOM)
 
    IncrementalDOM.patch(
      document.getElementById('target'),
      md.renderToIncrementalDOM('# Hello, Incremental DOM!')
    )
  </script> 
</body>
</html>

CDN

You can use the recent version through CDN provides by jsDelivr.

<script src="https://cdn.jsdelivr.net/npm/markdown-it-incremental-dom@2/dist/markdown-it-incremental-dom.min.js"></script>

Installation

We recommend using yarn to install.

$ yarn add incremental-dom markdown-it
$ yarn add markdown-it-incremental-dom

If you wanna use npm, try this:

$ npm install incremental-dom markdown-it --save
$ npm install markdown-it-incremental-dom --save

Usage

When injecting this plugin by .use(), you should pass Incremental DOM class as second argument. (window.IncrementalDOM by default)

const IncrementalDOM = require('incremental-dom')
const md = require('markdown-it')().use(
  require('markdown-it-incremental-dom'),
  IncrementalDOM
)

If it is succeed, 2 new rendering methods would be injected to instance.

TIPS: This plugin keeps default rendering methods render() and renderInline().

Option

You can pass option object as third argument. See below:

require('markdown-it')().use(
  require('markdown-it-incremental-dom'),
  IncrementalDOM,
  {
    incrementalizeDefaultRules: true,
  }
)
  • incrementalizeDefaultRules: For better performance, this plugin would override a few default renderer rules only when you calls injected methods. If the other plugins that override default rules have occurred any problem, You can disable overriding by setting false. (true by default)

Rendering methods

MarkdownIt.renderToIncrementalDOM(src[, env]) => Function

Similar to MarkdownIt.render(src[, env]) but it returns a function for Incremental DOM. It means doesn't render Markdown immediately.

You must render to DOM by using IncrementalDOM.patch(node, description). Please pass the returned function to the description argument. For example:

const node = document.getElementById('#target')
const func = md.renderToIncrementalDOM('# Hello, Incremental DOM!')
 
// It would render "<h1>Hello, Incremental DOM!</h1>" to <div id="target">
IncrementalDOM.patch(node, func)

MarkdownIt.renderInlineToIncrementalDOM(src[, env]) => Function

Similar to MarkdownIt.renderToIncrementalDOM but it wraps MarkdownIt.renderInline(src[, env]).

Renderer property

get MarkdownIt.IncrementalDOMRenderer => Renderer

Returns Renderer instance that includes Incremental DOM support.

It will inject Incremental DOM features into the current state of MarkdownIt.renderer at getting this property.

NOTE: This property is provided for the expert. Normally you should use renderToIncrementalDOM().

But it might be useful if you have to parse Markdown and operate tokens manually.

const md = new MarkdownIt()
const tokens = md.parse('# Hello')
 
// ...You can operate tokens here...
 
const patch = md.IncrementalDOMRenderer.render(tokens, md.options)
IncrementalDOM.patch(document.body, patch)

Development

$ git clone https://github.com/yhatt/markdown-it-incremental-dom
 
$ yarn install
$ yarn build

Lint & Format

$ yarn lint            # Run ESLint and Prettier to JS 
$ yarn lint --fix      # Fix lint and formatting of JS 
 
$ yarn format:check    # Run Prettier to Markdown, JSON and CSS 
$ yarn format --write  # Fix formatting by Prettier 

Publish to npm

$ npm publish

⚠️ Use npm >= 5.0.0.

Author

Yuki Hattori (@yhatt)

License

This plugin releases under the MIT License.

install

npm i markdown-it-incremental-dom

Downloadsweekly downloads

19

version

2.0.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability