vitepress-plugin-codesandbox
v0.1.4
Published
Add 'Open in CodeSandbox' buttons to VitePress code blocks
Downloads
544
Maintainers
Readme
vitepress-plugin-codesandbox
Add "Open in CodeSandbox" buttons to VitePress code blocks.
Installation
npm install vitepress-plugin-codesandboxUsage
In your VitePress theme setup (.vitepress/theme/index.ts):
import DefaultTheme from 'vitepress/theme'
import { useCodeSandbox } from 'vitepress-plugin-codesandbox'
import 'vitepress-plugin-codesandbox/style.css'
export default {
extends: DefaultTheme,
setup() {
useCodeSandbox()
}
}Options
useCodeSandbox({
// Languages to enable the button for (default: ['javascript', 'typescript'])
languages: ['javascript', 'typescript'],
// Custom HTML template (use {{SCRIPTS}} for script placeholder)
indexHtml: '<!DOCTYPE html>...',
// Additional scripts to load before user code
scripts: ['https://unpkg.com/[email protected]/lodash.min.js'],
// Filename for user code in sandbox (default: 'index.js')
filename: 'index.js',
// Button text (default: 'Open in CodeSandbox')
buttonText: 'Open in CodeSandbox',
// Button CSS class (default: 'code-sandbox-btn')
buttonClass: 'code-sandbox-btn',
})License
MIT
