A docute plugin to run code in docs with an iframe.
This plugin requires docute^2.9.0
Include the scripts before running docute.init:
<script src="https://unpkg.com/docute-iframe"></script>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
<div id="example"></div>
<script>
document.getElementById('example').innerHTML = '<strong>it works</strong>'
</script>
````
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 <script> tag and inserted into iframe body, you can customize it though.
Type: RegExp
Default: /^`{4}(.*?)[\n\r]+([\s\S]*?)[\n\r]+`{4}/gm
The regular expression we use to find runnable code.
Type: boolean
Default: true
Show highlighted source code before iframe.
Type: string
Prepend string to iframe body, eg:
docuteIframe({
prepend: '<script src="https://unpkg.com/vue@2.2.2/dist/vue.min.js"></script>'
})Then you can use Vue in your code.
Same as prepend but append to iframe body.
Type: string
Default: allow-modals allow-forms allow-pointer-lock allow-popups allow-same-origin allow-scripts
The sandbox attribute of iframe element.
Type: Array
Default: ['Prism', 'fetch']
Deliver some global variables of parent window to iframe, don't deliver variables that rely on window.document, since the parent window and iframe have different document.
Type: function
Default:
function defaultParseContent(lang, content) {
if (lang === 'js' || lang === 'javascript') {
return `<script>${content}</script>`
}
return content
}- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request :D
docute-iframe © egoist, Released under the MIT License.
Authored and maintained by egoist with help from contributors (list).
egoistian.com · GitHub @egoist · Twitter @rem_rin_rin