Skip to content

diplodoc-platform/color-extension

 
 

Repository files navigation

@diplodoc/color-extension

install

npm install @diplodoc/color-extension --save

use

var md = require('markdown-it')()
            .use(require('@diplodoc/color-extension'))

API

You can add options. Default option is below.

const md = require('markdown-it')()
            .use(require('@diplodoc/color-extension'), {
              defaultClassName: 'yfm-colorify',
              inline: false, // default
            })

md.render('{primary}(sample)') // => '<span class="yfm-colorify yfm-colorify--primary">sample</span>'

If you want to use inline style, use like below.

const md = require('markdown-it')()
            .use(require('@diplodoc/color-extension'), {
              inline: true,
            })

md.render('{red}(sample)') // => '<span class="yfm-colorify yfm-colorify--red" style="color: red;">sample</span>'

About

Inline color plugin for markdown-it

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 98.4%
  • JavaScript 1.6%