Docute Iframe

docute-iframe

[](https://npmjs.com/package/docute-iframe) [](https://npmjs.com/package/docute-iframe) [](https://circleci.com/gh/egoist/docute-iframe) [](https://github.com/egoist/donate)

A docute plugin to run code in docs with an iframe.

Usage

*This plugin requires docute^2.9.0*

Include the scripts before running `docute.init`:

Then activate the plugin:

docute.init({
  plugins: [
    docuteIframe()
  ]
})

Finally, you can write some fancy code examples which are `runnable`:

This is a **markdown** file, here it to demonstrate some code:

````html


  document.getElementById('example').innerHTML = 'it works'

````

**Note:** It's similar to gfm code blocks, which use triple backticks, but here you need to use **4 backticks** to mark it as runnable code while still have syntax highlight in your editor.

If the `language` of code block is `js` or `javascript`, it will be automatically wrapped in `` tag and inserted into iframe body, you can [customize it](#parsecontent) though.

API

docuteIframe([options])

options

match

Type: `RegExp`
Default: /^\`{4}(.\*?)[\n\r]+([\s\S]\*?)[\n\r]+\`{4}/gm

The regular expression we use to find runnable code.

showSourceCode

Type: `boolean`
Default: `true`

Show highlighted source code before iframe.

prepend

Type: `string`

Prepend string to iframe body, eg:

docuteIframe({
  prepend: ''
})