feat!: replace dgeni/gulp with TypeDoc for README generation

Replace the legacy dgeni/gulp documentation pipeline with TypeDoc
and typedoc-plugin-markdown. Generates plugin README files with
extracted @Plugin() decorator metadata. Register custom JSDoc tags
used by plugin source files.
This commit is contained in:
Daniel Sogl
2026-03-21 15:10:30 -07:00
parent a5e3ccd185
commit 76b4e03d04
283 changed files with 1249 additions and 1704 deletions
+6 -24
View File
@@ -1,36 +1,18 @@
# IRoot
```text
$ ionic cordova plugin add cordova-plugin-iroot
```
$ ionic cordova plugin add cordova-plugin-IRoot
$ npm install @awesome-cordova-plugins/i-root
```
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/iroot/)
## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/i-root/)
Plugin Repo: [https://github.com/WuglyakBolgoink/cordova-plugin-iroot](https://github.com/WuglyakBolgoink/cordova-plugin-iroot)
Plugin Repo: [https://github.com/WuglyakBolgoink/cordova-plugin-IRoot](https://github.com/WuglyakBolgoink/cordova-plugin-IRoot)
Use this plugin to add an extra layer of security for your app by detecting if the device was rooted (on android) or jailbreaked (on iOS).
## Supported platforms
* Android
* iOS
- Android
- iOS
## Original Plugin Notes
### iOS - Postinstall
To avoid errors like
> -canOpenURL: failed for URL: "cydia://package/com.example.package" - error: "This app is not allowed to query for scheme cydia"
dont forget to add `"cydia"` in `LSApplicationQueriesSchemes` key of `info.plist`. Otherwise `canOpenURL` will always return `false`.
```xml
<xxx>
<key>LSApplicationQueriesSchemes</key>
<array>
<string>cydia</string>
</array>
</xxx>
```