Skip to content

Commit cd5bf5e

Browse files
authored
Update README.md
1 parent 7a8cc87 commit cd5bf5e

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @capacitor/docgen
22

3-
Docs Readme Markdown and JSON Generator for Capacitor Plugins.
3+
Docs Readme Markdown and JSON Generator for [Capacitor](https://capacitorjs.com/) Plugins.
44

55
- Designed specifically for generating docs for Capacitor plugins using TypeScript
66
- Gerenates docs data pulled from [JSDocs](https://en.wikipedia.org/wiki/JSDoc) within source code
@@ -40,6 +40,7 @@ for Github and NPM, and the anchors within the docs can also be
4040
linked to and shared.
4141
```
4242

43+
4344
## CLI
4445

4546
Easiest way to run `docgen` is to install `@capacitor/docgen` as a dev dependency
@@ -56,3 +57,9 @@ docgen --api HapticsPlugin --output-readme README.md
5657
| `--output-readme` | `-r` | Path to the markdown file to update. Note that the file must already exist. **Required** |
5758
| `--output-json` | `-j` | Path to write the raw docs data as a json file. |
5859
| `--project` | `-p` | Path to the project's `tsconfig.json` file, same as the [project](https://www.typescriptlang.org/docs/handbook/compiler-options.html) flag for TypeScript's CLI. By default it'll attempt to find this file. |
60+
61+
62+
## Related
63+
64+
- [Capacitor](https://capacitorjs.com/)
65+
- [Capacitor Community Plugins](https://github.com/capacitor-community)

0 commit comments

Comments
 (0)