Markbox
Parse your code in markdown into CodeSandbox.
This preview is not real time parsed. After modifying the content, you need to click the
Runbutton to preview.
Usage
$ npm i markboxMarkbox will parse your markdown using marked and replace all of codes in markdown with Codesandbox embed iframe.
const markbox = require('markbox')
const markdownContent = `Your markdown content...`
const html = await markbox.parse(markdownContent)
Rules
Depends on your code languange, Markbox will transform your codes to different template.
Plain JavaScript
js, javascript
JavaScript (React)
jsx
Rather than writing full React render code, you can simply just write your React component and use mount() to mount it:
Vue
vue
Your single file Vue component will automatically render to the root element!
ReasonML
reason
others
Other unsupported language code will directly output as a normal code block.
Advanced Usage
ignore
You can add a <!-- ignore --> above the code to avoid the code being put into CodeSandbox:
console.log('I am not in CodeSandbox Now!')
API
parse(content: string, options: Options): Promise
Parse markdown to html string with marked
Options:
embedOptions?: object: CodeSandbox embed options objectfallback?: boolean: Show code block directly if CodeSandbox generating failed.falseis by default.useCache?: boolean: A in-memory cache that cache the sandbox_id in memory.trueis by default.
License
MIT License