@xiaopanda/vuepress-plugin-code-copy

    1.0.3 • Public • Published

    @xiaopanda/vuepress-plugin-code-copy

    NPM version NPM downloads NPM LICENSE

    English | 中文

    A VuePress plugin that copies code blocks with one click.

    Install

    yarn add -D @xiaopanda/vuepress-plugin-code-copy
    # OR 
    npm install -D @xiaopanda/vuepress-plugin-code-copy

    Usage

    The plugin needs to be added to the plugins under .vuepress/config.js in the VuePress project:

    module.exports = {
      plugins: ['@xiaopanda/vuepress-plugin-code-copy'] 
    }

    Options

    This plugin takes a number of options, which can be configured in the options object under plugin:

    module.exports = {
      plugins: [
        ['@xiaopanda/vuepress-plugin-code-copy', {
            buttonStaticIcon: Boolean,
            buttonIconTitle: String,
            buttonAlign: String,
            buttonColor: String
           }
        ]
      ]
    }

    buttonStaticIcon

    • Type: Boolean
    • Default: false

    The copy button is only visible when hovers the mouse over the code block, or always visible.

    buttonIconTitle

    • Type: String
    • Default: Copy

    The title content will appear when the mouse hovers over the copy button.

    buttonAlign

    • Type: String
    • Default: top
    • Supported options: top or bottom

    The copy button is aligned at the top-right or bottom-right corner of the code block.

    buttonColor

    • Type: String
    • Default: #ffffff

    The color of the copy button, you can set any Hex color codes.

    LICENSE

    MIT

    Install

    npm i @xiaopanda/vuepress-plugin-code-copy

    DownloadsWeekly Downloads

    165

    Version

    1.0.3

    License

    MIT

    Unpacked Size

    9.65 kB

    Total Files

    9

    Last publish

    Collaborators

    • panxingcheng