/ Documentation

A single component that provides simple documentation of Vue.js

A single component that provides simple documentation of Vue.js

propdoc

quick and easy documentation of Vue.js components.

A single component that provides simple documentation of Vue.js components/props.

installation

npm install --save propdoc

example output

This example was solely generated based on the extra fields described below.

Features

propdoc proposes a new way of documenting Vue components, by including some (or all) of the documentation in the component itself.

Benefits:

props can be directly annotated, making documentation essentially the same as commenting a prop
Documentation can live directly in the component - thus centralizing the documentation and hopefully helping the development/documentation cycle

Downsides:

If all documentation is built into the options object, the component will use additional space
This can be mitigated by externalizing the larger proposed keys such as description and token

GitHub