README.md

vuepress-plugin-code-doc

🤩🤩🤩Writing Vuepress Documents Like Element-UI

📚中文文档 丨 📚English Docs

Installation

Install plugin for your Vuepress project.

    $ yarn add vuepress-plugin-code-doc
    #or
    $ npm i vuepress-plugin-code-doc

Usage

In .vuepress/config.js, require the plugin and set it to the config. as follow:

const CodeDocPlugin = require('vuepress-plugin-code-doc')
const CodeDocOpt = {}

module.exports = {
    title: 'Vuepress Plugin Code Doc',
    plugins: [[CodeDocPlugin, CodeDocOpt]]
}

Options

Name	Description	type	Accepted Values	Default
schema	code block mark	string	---	:
scrollViewSelector	scrollViewSelector	string	---	html