Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vxhly/vuepress-plugin-code-preview
vuepress plugin for codesandbox embed code preview
https://github.com/vxhly/vuepress-plugin-code-preview
Last synced: about 1 month ago
JSON representation
vuepress plugin for codesandbox embed code preview
- Host: GitHub
- URL: https://github.com/vxhly/vuepress-plugin-code-preview
- Owner: vxhly
- License: other
- Created: 2020-08-19T09:59:05.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-08-21T12:08:01.000Z (over 4 years ago)
- Last Synced: 2025-01-10T13:36:48.465Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 3.91 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vuepress-plugin-code-preview
> A vuepress plugin for codesandbox embed code preview
[](https://www.npmjs.com/package/vuepress-plugin-code-preview)
[](https://github.com/vxhly/vuepress-plugin-code-preview/stargazers)
[](https://github.com/vxhly/vuepress-plugin-code-preview/blob/master/LICENSE)## Install
``` bash
# install dependencies
npm i vuepress-plugin-code-preview -D# or use yarn
yarn add vuepress-plugin-code-preview -D
```## Usage
Write vuepress config
``` javascript
module.exports = {
plugins: ['code-preview']
}
```Write article
``` markdown
```
## Options
### embedUrl
Copy codesandbox embed url to it.
- type: *String*
- required: *true*
- default: *null*### embedBox
Code embedding platform.
- type: *String*
- required: *fasle*
- default: *codesandbox*## License
[MIT](https://github.com/vxhly/vuepress-plugin-code-preview/blob/master/LICENSE).