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: 3 months 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 (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-08-21T12:08:01.000Z (almost 5 years ago)
• Last Synced: 2025-03-05T12:11:50.170Z (3 months 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

[![npm](https://img.shields.io/npm/v/vuepress-plugin-code-preview.svg)](https://www.npmjs.com/package/vuepress-plugin-code-preview)

[![GitHub stars](https://img.shields.io/github/stars/vxhly/vuepress-plugin-code-preview)](https://github.com/vxhly/vuepress-plugin-code-preview/stargazers)

[![GitHub license](https://img.shields.io/github/license/vxhly/vuepress-plugin-code-preview)](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).