https://github.com/2nthony/docute-demo-code

🔥Live code block for Docute
https://github.com/2nthony/docute-demo-code

demo document documentation docute plugin vue

Last synced: 4 months ago
JSON representation

🔥Live code block for Docute

• Host: GitHub
• URL: https://github.com/2nthony/docute-demo-code
• Owner: 2nthony
• License: mit
• Created: 2019-03-31T12:54:01.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-12-15T11:37:33.000Z (about 1 year ago)
• Last Synced: 2024-10-12T08:44:04.866Z (4 months ago)
• Topics: demo, document, documentation, docute, plugin, vue
• Language: TypeScript
• Homepage: https://docute-demo-code.now.sh
• Size: 536 KB
• Stars: 15
• Watchers: 1
• Forks: 2
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# docute-demo-code

> 🔥Live code block for Docute

Please consider starring the project to show your ❤️ and support.

> Only support Vue SFC string!  

> For others you might want to try [docute-run-code](https://github.com/egoist/docute-plugins/tree/master/packages/run-code)

[![NPM version](https://badgen.net/npm/v/docute-demo-code?icon=npm)](https://npmjs.com/package/docute-demo-code)

[![NPM download](https://badgen.net/npm/dm/docute-demo-code?icon=npm)](https://npmjs.com/package/docute-demo-code)

[![CircleCI](https://badgen.net/circleci/github/evillt/docute-demo-code?icon=circleci)](https://circleci.com/gh/evillt/docute-demo-code/tree/master)

[![](https://badgen.net/jsdelivr/hits/npm/docute-demo-code)](https://www.jsdelivr.com/package/npm/docute-demo-code)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

[![License](https://badgen.net/npm/license/docute-demo-code)](./LICENSE)

[![$donate](https://badgen.net/badge/suport%20me/donate/f2a)](https://patreon.com/evillt)

### 🤗Checkout the [live demo](https://docute-demo-code.now.sh)

## Usage

First load this plugin via `` tag:

```html

<!-- Load this plugin after docute.js -->

<script src="https://cdn.jsdelivr.net/npm/docute-demo-code">

```

This plugin exposed as `window.docuteDemoCode`

```js

new Docute({

  ...

  plugins: [

    docuteDemoCode()

  ]

})

```

Then, you can write a demo code block with live demo in `.md` file:  

(Don't forget to specify the code language to `html` or `vue`)

    # Introduction

    > Showcase for demo code

    :::demo

    ```html

    

      
{{ msg }}

    


    

    export default {

      data() {

        return {

          msg: 'Hi, 😋'

        }

      }

    }

    

    ```

    :::

Similar to vuepress custom container huh?

## Use With Bundlers

```console

yarn add docute-demo-code --dev

```

### Webpack

In your entry file:

```js

import Docute from 'docute'

import docuteDemoCode from 'docute-demo-code'

new Docute({

  ...

  plugins: [

    docuteDemoCode()

  ]

})

```

## API

`docuteDemoCode(options: Options)`

### showBorder

- Type: `boolean`

- Default: `true`

Use docute style to wrap living demo block

## Relate

- [docute-custom-container](https://github.com/evillt/docute-custom-container)

## Contributing

1. Fork it!

2. Create your feature branch: `git checkout -b my-new-feature`

3. Commit your changes: `git commit -am 'Add some feature'`

4. Push to the branch: `git push origin my-new-feature`

5. Submit a pull request :D

## Author

**docute-demo-code** © [evillt](https://github.com/evillt), Released under the [MIT](./LICENSE) License.

Authored and maintained by **EVILLT** with help from contributors ([list](https://github.com/evillt/docute-demo-code/contributors)).

> [evila.me](https://evila.me) · GitHub [@evillt](https://github.com/evillt) · Twitter [@evillt](https://twitter.com/evillt)