rollup-plugin-vuedoc
Rollup plugin to generate markdown documentation from Vue.js component source with @vuedoc/md.
Usage
- Install the plugin.
npm i -D rollup-plugin-vuedoc
- Edit the config file to use the plugin.
import vuedoc from 'rollup-plugin-vuedoc';
export default {
input: 'path/to/entry-point.js',
...generalConfigurations,
plugins: [
vuedoc({ test: /\.vue$/, prefix: 'docs' }),
...otherPlugins,
],
};
- Run rollup.
- Markdown files will be created in the asset path.
Options
test
Generate markdown files only if the module ID matches the test. Can be a string,
RegExp, or an array of them.
prefix
Path prefix for generated markdown files. Files will be put at
<asset path>/<prefix>/<module's relative path>
intro/outro
String to be prepended before or appended after generated markdown strings. Can
be a string or a function. Function will be called with an argument object including
id of the module.
export default {
...generalConfigs,
plugins: [
vuedoc({ intro: ({ id }) => `id` }),
...otherPlugins,
],
};
index
If true, generate indix markdowns containing a directory name string as the title
at each directory under the prefix path. If function is given, returning string
will be the content of the index. Functions are called with a directory path.
replace
Replaces substrings of generated markdown strings. test
property and replacement
property of the replace
object will be passed to String.prototype.replace()
function.
export default {
...generalConfigs,
plugins: [
vuedoc({ replace: { test: /to be replaced/g, replacement: 'replaced' }),
...otherPlugins,
],
};