https://github.com/h-ikeda/rollup-plugin-vuedoc
Rollup plugin to generate markdown documentation from Vue.js component source with @vuedoc/md.
https://github.com/h-ikeda/rollup-plugin-vuedoc
Last synced: 4 months ago
JSON representation
Rollup plugin to generate markdown documentation from Vue.js component source with @vuedoc/md.
- Host: GitHub
- URL: https://github.com/h-ikeda/rollup-plugin-vuedoc
- Owner: h-ikeda
- License: mit
- Created: 2019-12-31T14:30:29.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-08-28T07:22:16.000Z (almost 5 years ago)
- Last Synced: 2025-01-11T00:08:54.841Z (5 months ago)
- Language: JavaScript
- Size: 119 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rollup-plugin-vuedoc
Rollup plugin to generate markdown documentation from Vue.js component source with @vuedoc/md.
[](https://nodei.co/npm/rollup-plugin-vuedoc/)
## Usage
1. Install the plugin.
```sh
npm i -D rollup-plugin-vuedoc
```
2. Edit the config file to use the plugin.
```js
// rollup.config.js
import vuedoc from 'rollup-plugin-vuedoc';
export default {
input: 'path/to/entry-point.js',
...generalConfigurations,
plugins: [
vuedoc({ test: /\.vue$/, prefix: 'docs' }),
...otherPlugins,
],
};
```
3. Run rollup.
4. 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
\/\/\
### 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.
```js
export default {
...generalConfigs,
plugins: [
vuedoc({ intro: ({ id }) => `id` }),
...otherPlugins,
],
};
// Generates markdown files starting with module's ID string.
```
### 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.
```js
export default {
...generalConfigs,
plugins: [
vuedoc({ replace: { test: /to be replaced/g, replacement: 'replaced' }),
...otherPlugins,
],
};
// String.prototype.replace(/to be replaced/g, 'replaced') will be applied.
```