Security News
Highlights from the 2024 Rails Community Survey
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
rollup-plugin-vuedoc
Advanced tools
Rollup plugin to generate markdown documentation from Vue.js component source with @vuedoc/md.
Rollup plugin to generate markdown documentation from Vue.js component source with @vuedoc/md.
npm i -D rollup-plugin-vuedoc
// 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,
],
};
Generate markdown files only if the module ID matches the test. Can be a string, RegExp, or an array of them.
Path prefix for generated markdown files. Files will be put at <asset path>/<prefix>/<module's relative path>
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,
],
};
// Generates markdown files starting with module's ID string.
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.
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,
],
};
// String.prototype.replace(/to be replaced/g, 'replaced') will be applied.
FAQs
Rollup plugin to generate markdown documentation from Vue.js component source with @vuedoc/md.
The npm package rollup-plugin-vuedoc receives a total of 1 weekly downloads. As such, rollup-plugin-vuedoc popularity was classified as not popular.
We found that rollup-plugin-vuedoc demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.