markdown-it-copy

[![NPM version][npm-image]][npm-url]
[![download][downloads-image]][github-url]

[![NPM][nodei-image]][npm-url]

> A markdown-it-plugin that copy code and others.

Todo

* [ ] 复制内容尾部增加版权说明

Example

🔗 example

!image_png

Installation

``bash
npm install markdown-it-copy -S
`

Usage

$3

`js
const options = {
btnText: String, // 'copy' | button text
failText: String, // 'copy fail' | copy-fail text
successText: String, // 'copy success' | copy-success text
successTextDelay: Number, // 2000 | successText show time [ms]
extraHtmlBeforeBtn: String, // '' | a html-fragment before
extraHtmlAfterBtn: String, // '' | a html-fragment after
showCodeLanguage: Boolean, // false | show code language before [btn || extraHtmlBeforeBtn] | [add-after-1.1.0]
attachText: String, // '' | some text append copyText， Such as: copyright | [add-after-1.2.0]
};

const md = require('markdown-it')()
.use(require('markdown-it-copy'), options);

md.render(${mdText});

// Tips: you may need to highlight your code, as follow:

const hljs = require('highlight.js');
const hlOpts = {
highlight(str, lang) {
if (lang && hljs.getLanguage(lang)) {
try {
return hljs.highlight(lang, str).value;
} catch (__) {
console.log(__);
}
}
return '';
},
};

require('markdown-it')(hlOpts);
`

$3

Normal-theme:

* css: default.css
* stylus: default.styl

also, you can write style by yourself.

the html structure and class as follow:

`html


${codeLang}
${extraHtmlBeforeBtn}

${successText}


${btnText}

${extraHtmlAfterBtn}