Cordova plugins documentation currently live separated from source code so that sync issues can occur on commits. Proposed solution uses JSDoc to generate a plugin API docs, while allows to wrap the generated docs into template (markdown with handlebars partials) with extra-details like Quirks or additional examples.
Proposal is currently implemented for cordova-plugin-camera only: generated doc result.
Pros:
Cons:
Summary instructions:
jsdoc2md/TEMPLATE.md
,www
folder source code using JSDoc,<a>
with name
,npm install
to install dev dependencies,npm install
is required).