Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
@capacitor/docgen
Advanced tools
Docs Readme Markdown and JSON Generator for Capacitor Plugins.
npm i @capacitor/docgen --save-dev
# My Capacitor Plugin 🔌
The readme file can be formatted however you'd like. Just insert
the docgen placeholder elements where the index of the API methods,
and the API docs should go.
Below is an index of all the methods available.
<docgen-index></docgen-index>
## Custom Readme Content
Manage your readme content however, and on every `docgen` rebuild
it will leave the original content as is, but update the inner text
of the docgen placeholder elements with the updated generated docs.
<docgen-api></docgen-api>
## Commit Your Readme 🚀
The benefit of this readme file is that is also acts as the landing
page for the Github repo and NPM package, and the anchors within the
docs can also be linked to and shared.
Easiest way to run docgen
is to install @capacitor/docgen
as a dev dependency
and add the command to the package.json
scripts. In the example below,
HapticsPlugin
is the primary interface:
docgen --api HapticsPlugin --output-readme README.md
Flag | Alias | Description |
---|---|---|
--api | -a | The name of the primary application programming interface. Required |
--output-readme | -r | Path to the markdown file to update. Note that the file must already exist. Required |
--output-json | -j | Path to write the raw docs data as a json file. |
--project | -p | Path to the project's tsconfig.json file, same as the project flag for TypeScript's CLI. By default it'll attempt to find this file. |
{
"scripts": {
"docgen": "docgen --api HapticsPlugin --output-readme README.md"
}
}
The same API that's available to the CLI can also be imported from @capacitor/docgen
.
FAQs
Docs Readme Markdown and JSON Generator for Capacitor Plugins
The npm package @capacitor/docgen receives a total of 23,674 weekly downloads. As such, @capacitor/docgen popularity was classified as popular.
We found that @capacitor/docgen demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 8 open source maintainers 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
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.