- This plugin is still in beta stage and may not work as expected. Please - submit any issues to the plugin repo. -
- - ``` $ ionic cordova plugin add cordova-plugin-camera-preview $ npm install @awesome-cordova-plugins/camera-preview @@ -23,7 +16,5 @@ Requires Cordova plugin: `https://github.com/cordova-plugin-camera-preview/cordo ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/camera/README.md b/docs/plugins/camera/README.md index 400e127e4..67c5bca1c 100644 --- a/docs/plugins/camera/README.md +++ b/docs/plugins/camera/README.md @@ -24,9 +24,7 @@ inside of the `- This plugin is still in beta stage and may not work as expected. Please - submit any issues to the plugin repo. -
- - ``` $ ionic cordova plugin add cordova-plugin-firebase-analytics $ npm install @awesome-cordova-plugins/firebase-analytics @@ -41,7 +34,5 @@ And in the same file, you'll have to add `xmlns:tools="http://schemas.android.co ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/firebase-authentication/README.md b/docs/plugins/firebase-authentication/README.md index 44926a90b..1ebb3d360 100644 --- a/docs/plugins/firebase-authentication/README.md +++ b/docs/plugins/firebase-authentication/README.md @@ -14,7 +14,5 @@ Cordova plugin for Firebase Authentication ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/firebase-config/README.md b/docs/plugins/firebase-config/README.md index a18dd257c..a25b52c13 100644 --- a/docs/plugins/firebase-config/README.md +++ b/docs/plugins/firebase-config/README.md @@ -1,12 +1,5 @@ # Firebase Config -- This plugin is still in beta stage and may not work as expected. Please - submit any issues to the plugin repo. -
- - ``` $ ionic cordova plugin add cordova-plugin-firebase-config $ npm install @awesome-cordova-plugins/firebase-config @@ -21,7 +14,5 @@ Cordova plugin for Firebase Config ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/firebase-crash/README.md b/docs/plugins/firebase-crash/README.md index 9b8f72fc3..99b56790f 100644 --- a/docs/plugins/firebase-crash/README.md +++ b/docs/plugins/firebase-crash/README.md @@ -14,7 +14,5 @@ This plugin brings crash reporting from Google Firebase to your Cordova project! ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/firebase-crashlytics/README.md b/docs/plugins/firebase-crashlytics/README.md index a5ff503b2..b68d69cf5 100644 --- a/docs/plugins/firebase-crashlytics/README.md +++ b/docs/plugins/firebase-crashlytics/README.md @@ -14,7 +14,5 @@ A Google Firebase Crashlytics plugin to enable capture of crash reports. ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/firebase-dynamic-links/README.md b/docs/plugins/firebase-dynamic-links/README.md index 10217acc3..b3e1f9802 100644 --- a/docs/plugins/firebase-dynamic-links/README.md +++ b/docs/plugins/firebase-dynamic-links/README.md @@ -1,12 +1,5 @@ # Firebase Dynamic Links -- This plugin is still in beta stage and may not work as expected. Please - submit any issues to the plugin repo. -
- - ``` $ ionic cordova plugin add cordova-plugin-firebase-dynamiclinks --save --variable APP_DOMAIN="example.com" --variable APP_PATH="/" $ npm install @awesome-cordova-plugins/firebase-dynamic-links @@ -39,7 +32,5 @@ config.xml: ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/firebase-messaging/README.md b/docs/plugins/firebase-messaging/README.md index c75f0343f..13b466721 100644 --- a/docs/plugins/firebase-messaging/README.md +++ b/docs/plugins/firebase-messaging/README.md @@ -1,12 +1,5 @@ # Firebase Messaging -- This plugin is still in beta stage and may not work as expected. Please - submit any issues to the plugin repo. -
- - ``` $ ionic cordova plugin add cordova-plugin-firebase-messaging $ npm install @awesome-cordova-plugins/firebase-messaging @@ -21,7 +14,5 @@ Cordova plugin for Firebase Messaging ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/firebase-model/README.md b/docs/plugins/firebase-model/README.md index 3ca641076..d741b5c42 100644 --- a/docs/plugins/firebase-model/README.md +++ b/docs/plugins/firebase-model/README.md @@ -1,14 +1,12 @@ -# FirebaseModelInput -Result -t -cordova plugin add cordova-plugin-firebase-model +# Firebase Model + +``` +$ ionic cordova plugin add cordova-plugin-firebase-model $ npm install @awesome-cordova-plugins/firebase-model ``` ## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/firebase-model/) -Plugin Repo: ['']('') - This plugin downloads the TensorFlow model from firebase and classify the images. ```typescript @@ -40,6 +38,4 @@ catch (e) { ## Supported platforms - iOS - - diff --git a/docs/plugins/firebase-vision/README.md b/docs/plugins/firebase-vision/README.md index 59173966e..763e61755 100644 --- a/docs/plugins/firebase-vision/README.md +++ b/docs/plugins/firebase-vision/README.md @@ -14,7 +14,5 @@ Cordova plugin for Firebase MLKit Vision ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/firebase-x/README.md b/docs/plugins/firebase-x/README.md index 716a7aa2d..fa0c50153 100644 --- a/docs/plugins/firebase-x/README.md +++ b/docs/plugins/firebase-x/README.md @@ -15,7 +15,5 @@ It is a maintained fork from unmaintained ionic-navite plugin called Firebase. ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/firebase/README.md b/docs/plugins/firebase/README.md index 86efe703b..ca130b873 100644 --- a/docs/plugins/firebase/README.md +++ b/docs/plugins/firebase/README.md @@ -14,7 +14,5 @@ This plugin brings push notifications, analytics, event tracking, crash reportin ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/flashlight/README.md b/docs/plugins/flashlight/README.md index 1b0377b1f..b05a90a32 100644 --- a/docs/plugins/flashlight/README.md +++ b/docs/plugins/flashlight/README.md @@ -16,8 +16,6 @@ Requires Cordova plugin: `cordova-plugin-flashlight`. For more info, please see ## Supported platforms - Android - - iOS - - Windows Phone 8 - - +- iOS +- Windows Phone 8 diff --git a/docs/plugins/foreground-service/README.md b/docs/plugins/foreground-service/README.md index 360bf2325..7bf15d204 100644 --- a/docs/plugins/foreground-service/README.md +++ b/docs/plugins/foreground-service/README.md @@ -27,6 +27,4 @@ For android API 28+, the following xml snippet should be inserted into ```config ## Supported platforms - Android - - diff --git a/docs/plugins/ftp/README.md b/docs/plugins/ftp/README.md index 540302252..c53359fa6 100644 --- a/docs/plugins/ftp/README.md +++ b/docs/plugins/ftp/README.md @@ -14,7 +14,5 @@ This cordova plugin is created to use ftp (client) in web/js. ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/gao-de-location/README.md b/docs/plugins/gao-de-location/README.md index b0fb1097c..3360bfad4 100644 --- a/docs/plugins/gao-de-location/README.md +++ b/docs/plugins/gao-de-location/README.md @@ -15,7 +15,5 @@ Gaode location can directly return address informationGaode location can directl ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/gcdwebserver/README.md b/docs/plugins/gcdwebserver/README.md index 78792d815..3c1de1538 100755 --- a/docs/plugins/gcdwebserver/README.md +++ b/docs/plugins/gcdwebserver/README.md @@ -1,7 +1,7 @@ # gcdwebserver ``` -$ '' +$ $ npm install @awesome-cordova-plugins/gcdwebserver ``` @@ -14,6 +14,4 @@ This plugin can start an HTTP server using GCDWebServer ## Supported platforms - iOS - - diff --git a/docs/plugins/ge-tui-sdk-plugin/README.md b/docs/plugins/ge-tui-sdk-plugin/README.md index 407689c90..5d773bb57 100644 --- a/docs/plugins/ge-tui-sdk-plugin/README.md +++ b/docs/plugins/ge-tui-sdk-plugin/README.md @@ -14,7 +14,5 @@ This plugin does something ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/genius-scan/README.md b/docs/plugins/genius-scan/README.md new file mode 100644 index 000000000..b4ddabcae --- /dev/null +++ b/docs/plugins/genius-scan/README.md @@ -0,0 +1,16 @@ +# Genius Scan + +``` +$ ionic cordova plugin add @thegrizzlylabs/cordova-plugin-genius-scan +$ npm install @awesome-cordova-plugins/genius-scan +``` + +## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/genius-scan/) + +Plugin allows you to access the Genius Scan SDK core features from a Ionic application + +## Supported platforms + +- Android +- iOS + diff --git a/docs/plugins/geolocation/README.md b/docs/plugins/geolocation/README.md index fa4ffc056..965f64710 100644 --- a/docs/plugins/geolocation/README.md +++ b/docs/plugins/geolocation/README.md @@ -23,10 +23,8 @@ For iOS you have to add this configuration to your configuration.xml file ## Supported platforms - Amazon Fire OS - - Android - - Browser - - iOS - - Windows - - +- Android +- Browser +- iOS +- Windows diff --git a/docs/plugins/globalization/README.md b/docs/plugins/globalization/README.md index 5277ea797..6f0db4985 100644 --- a/docs/plugins/globalization/README.md +++ b/docs/plugins/globalization/README.md @@ -14,10 +14,8 @@ This plugin obtains information and performs operations specific to the user's l ## Supported platforms - Amazon Fire OS - - Android - - Browser - - iOS - - Windows - - +- Android +- Browser +- iOS +- Windows diff --git a/docs/plugins/google-analytics/README.md b/docs/plugins/google-analytics/README.md index 7245356e8..191b3ad13 100644 --- a/docs/plugins/google-analytics/README.md +++ b/docs/plugins/google-analytics/README.md @@ -18,9 +18,7 @@ Prerequisites: ## Supported platforms - Android - - Browser - - iOS - - Windows Phone 8 - - +- Browser +- iOS +- Windows Phone 8 diff --git a/docs/plugins/google-nearby/README.md b/docs/plugins/google-nearby/README.md index 87778e95e..2d21e68e0 100644 --- a/docs/plugins/google-nearby/README.md +++ b/docs/plugins/google-nearby/README.md @@ -14,6 +14,4 @@ This plugin adds support for the Google Nearby Messages API. ## Supported platforms - Android - - diff --git a/docs/plugins/google-plus/README.md b/docs/plugins/google-plus/README.md index a3fab1964..611d01fc4 100644 --- a/docs/plugins/google-plus/README.md +++ b/docs/plugins/google-plus/README.md @@ -9,12 +9,8 @@ $ npm install @awesome-cordova-plugins/google-plus Plugin Repo: [https://github.com/EddyVerbruggen/cordova-plugin-googleplus](https://github.com/EddyVerbruggen/cordova-plugin-googleplus) - - ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/header-color/README.md b/docs/plugins/header-color/README.md index c8fbccb90..4be58fdf3 100644 --- a/docs/plugins/header-color/README.md +++ b/docs/plugins/header-color/README.md @@ -14,6 +14,4 @@ Cordova plugin to change color of header in Android Multitask View ## Supported platforms - Android - - diff --git a/docs/plugins/health-kit/README.md b/docs/plugins/health-kit/README.md index 8b8a7bdf1..95562faf9 100644 --- a/docs/plugins/health-kit/README.md +++ b/docs/plugins/health-kit/README.md @@ -15,6 +15,4 @@ Any data saved shows up in the iOS Health app and is available for other iOS app ## Supported platforms - iOS - - diff --git a/docs/plugins/health/README.md b/docs/plugins/health/README.md index d2bac2c06..97b5b0a72 100644 --- a/docs/plugins/health/README.md +++ b/docs/plugins/health/README.md @@ -14,7 +14,5 @@ A plugin that abstracts fitness and health repositories like Apple HealthKit or ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/http/README.md b/docs/plugins/http/README.md index be1ec56d4..b78eed033 100644 --- a/docs/plugins/http/README.md +++ b/docs/plugins/http/README.md @@ -19,7 +19,5 @@ Advantages over Javascript requests: ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/hyper-track/README.md b/docs/plugins/hyper-track/README.md index d1a04f840..1d4febf12 100644 --- a/docs/plugins/hyper-track/README.md +++ b/docs/plugins/hyper-track/README.md @@ -1,6 +1,7 @@ -# Coordinates -alidationError -ic cordova plugin add cordova-plugin-hypertrack-v3 +# HyperTrackPlugin + +``` +$ ionic cordova plugin add cordova-plugin-hypertrack-v3 $ npm install @awesome-cordova-plugins/hyper-track ``` @@ -8,11 +9,7 @@ $ npm install @awesome-cordova-plugins/hyper-track Plugin Repo: [https://github.com/hypertrack/cordova-plugin-hypertrack.git](https://github.com/hypertrack/cordova-plugin-hypertrack.git) - - ## Supported platforms - Android, iOS - - diff --git a/docs/plugins/i-root/README.md b/docs/plugins/i-root/README.md index 403364d54..b6a7cf0fb 100644 --- a/docs/plugins/i-root/README.md +++ b/docs/plugins/i-root/README.md @@ -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" - -don’t forget to add `"cydia"` in `LSApplicationQueriesSchemes` key of `info.plist`. Otherwise `canOpenURL` will always return `false`. - -```xml -- This plugin is still in beta stage and may not work as expected. Please - submit any issues to the plugin repo. -
- - ``` $ cordova plugin add cordova-plugin-theme-detection $ npm install @awesome-cordova-plugins/theme-detection @@ -21,7 +14,5 @@ Cordova plugin to detect whether dark mode is enabled or not ## Supported platforms - iOS - - Android - - +- Android diff --git a/docs/plugins/three-dee-touch/README.md b/docs/plugins/three-dee-touch/README.md index 4242a6555..ec7a8557c 100644 --- a/docs/plugins/three-dee-touch/README.md +++ b/docs/plugins/three-dee-touch/README.md @@ -1,13 +1,13 @@ # 3D Touch ``` -$ ionic cordova plugin add cordova-plugin-3dtouch +$ ionic cordova plugin add @herdwatch/cordova-plugin-3dtouch $ npm install @awesome-cordova-plugins/three-dee-touch ``` ## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/three-dee-touch/) -Plugin Repo: [https://github.com/EddyVerbruggen/cordova-plugin-3dtouch](https://github.com/EddyVerbruggen/cordova-plugin-3dtouch) +Plugin Repo: [https://github.com/herdwatch-apps/cordova-plugin-3dtouch](https://github.com/herdwatch-apps/cordova-plugin-3dtouch) The 3D Touch plugin adds 3D Touch capabilities to your Cordova app. @@ -16,6 +16,4 @@ Requires Cordova plugin: `cordova-plugin-3dtouch`. For more info, please see the ## Supported platforms - iOS - - diff --git a/docs/plugins/toast/README.md b/docs/plugins/toast/README.md index 4e719a831..34e322c40 100644 --- a/docs/plugins/toast/README.md +++ b/docs/plugins/toast/README.md @@ -16,10 +16,8 @@ Requires Cordova plugin: `cordova-plugin-x-toast`. For more info, please see the ## Supported platforms - Android - - BlackBerry 10 - - iOS - - Windows - - Windows Phone 8 - - +- BlackBerry 10 +- iOS +- Windows +- Windows Phone 8 diff --git a/docs/plugins/touch-id/README.md b/docs/plugins/touch-id/README.md index 7d521590d..f7ab072ea 100644 --- a/docs/plugins/touch-id/README.md +++ b/docs/plugins/touch-id/README.md @@ -16,6 +16,4 @@ Requires Cordova plugin: `cordova-plugin-touch-id`. For more info, please see th ## Supported platforms - iOS - - diff --git a/docs/plugins/unique-device-id/README.md b/docs/plugins/unique-device-id/README.md index 92e6800f3..0270c4f6a 100644 --- a/docs/plugins/unique-device-id/README.md +++ b/docs/plugins/unique-device-id/README.md @@ -1,7 +1,7 @@ # Unique Device ID ``` -$ '' +$ $ npm install @awesome-cordova-plugins/unique-device-id ``` @@ -14,8 +14,6 @@ This plugin produces a unique, cross-install, app-specific device id. ## Supported platforms - Android - - iOS - - Windows Phone 8 - - +- iOS +- Windows Phone 8 diff --git a/docs/plugins/unvired-cordova-sdk/README.md b/docs/plugins/unvired-cordova-sdk/README.md index 9848c3c1e..e192072f6 100644 --- a/docs/plugins/unvired-cordova-sdk/README.md +++ b/docs/plugins/unvired-cordova-sdk/README.md @@ -1,7 +1,7 @@ -# SyncResult -ult -ivateResult -ionic cordova plugin add @awesome-cordova-plugins/unvired-cordova-sdk +# Unvired Cordova SDK + +``` +$ ionic cordova plugin add @awesome-cordova-plugins/unvired-cordova-sdk $ npm install @awesome-cordova-plugins/unvired-cordova-sdk ``` @@ -31,9 +31,7 @@ After you install the plugin, for Ionic/Angular projects, please add a reference ## Supported platforms - iOS - - Android - - Windows - - Browser - - +- Android +- Windows +- Browser diff --git a/docs/plugins/uptime/README.md b/docs/plugins/uptime/README.md index baa5e41d9..ed69dae31 100644 --- a/docs/plugins/uptime/README.md +++ b/docs/plugins/uptime/README.md @@ -14,7 +14,5 @@ This plugin provides the time spent in milliseconds since boot (uptime). ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/urbanairship/README.md b/docs/plugins/urbanairship/README.md index d274b0a43..364a554f1 100644 --- a/docs/plugins/urbanairship/README.md +++ b/docs/plugins/urbanairship/README.md @@ -14,7 +14,5 @@ This plugin does something ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/usabilla-cordova-sdk/README.md b/docs/plugins/usabilla-cordova-sdk/README.md index 8e434ce56..c126a3368 100644 --- a/docs/plugins/usabilla-cordova-sdk/README.md +++ b/docs/plugins/usabilla-cordova-sdk/README.md @@ -17,7 +17,5 @@ For more info see [Cordova plugin docs](https://github.com/usabilla/usabilla-u4a ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/vibes/README.md b/docs/plugins/vibes/README.md index 73e20ba6b..7188f765f 100644 --- a/docs/plugins/vibes/README.md +++ b/docs/plugins/vibes/README.md @@ -14,7 +14,5 @@ This plugin enables integration with the Vibes Push SDK to your Cordova project ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/vibration/README.md b/docs/plugins/vibration/README.md index 8ad09aa7a..5fa858be7 100644 --- a/docs/plugins/vibration/README.md +++ b/docs/plugins/vibration/README.md @@ -14,8 +14,6 @@ Vibrates the device ## Supported platforms - Android - - iOS - - Windows - - +- iOS +- Windows diff --git a/docs/plugins/video-editor/README.md b/docs/plugins/video-editor/README.md index 89f552b76..288f89530 100644 --- a/docs/plugins/video-editor/README.md +++ b/docs/plugins/video-editor/README.md @@ -14,9 +14,7 @@ Edit videos using native device APIs ## Supported platforms - Android - - iOS - - Windows - - Windows Phone 8 - - +- iOS +- Windows +- Windows Phone 8 diff --git a/docs/plugins/video-player/README.md b/docs/plugins/video-player/README.md index 5075331b1..88cb3e6d5 100644 --- a/docs/plugins/video-player/README.md +++ b/docs/plugins/video-player/README.md @@ -16,6 +16,4 @@ Requires Cordova plugin: `com.moust.cordova.videoplayer`. For more info, please ## Supported platforms - Android - - diff --git a/docs/plugins/we-cap-inbox/README.md b/docs/plugins/we-cap-inbox/README.md new file mode 100644 index 000000000..78aee16aa --- /dev/null +++ b/docs/plugins/we-cap-inbox/README.md @@ -0,0 +1,18 @@ +# WE Cap Inbox + +``` +$ ionic cordova plugin add we-notificationinbox-cordova +$ npm install @awesome-cordova-plugins/we-cap-inbox +``` + +## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/we-cap-inbox/) + +Plugin Repo: [https://github.com/WebEngage/we-ionic-notification-inbox](https://github.com/WebEngage/we-ionic-notification-inbox) + +This plugin provides functionalities to manage notifications in your app. + +## Supported platforms + +- Android +- iOS + diff --git a/docs/plugins/web-intent/README.md b/docs/plugins/web-intent/README.md index 09d262989..7cbe8b1fa 100644 --- a/docs/plugins/web-intent/README.md +++ b/docs/plugins/web-intent/README.md @@ -14,6 +14,4 @@ This Plugin provides a general purpose shim layer for the Android intent mechani ## Supported platforms - Android - - diff --git a/docs/plugins/web-server/README.md b/docs/plugins/web-server/README.md index 29ef8ce0e..8f68db310 100644 --- a/docs/plugins/web-server/README.md +++ b/docs/plugins/web-server/README.md @@ -14,7 +14,5 @@ This plugin allows you to start a local dynamic content web server for android a ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/web-socket-server/README.md b/docs/plugins/web-socket-server/README.md index 42091faff..7d6829b63 100644 --- a/docs/plugins/web-socket-server/README.md +++ b/docs/plugins/web-socket-server/README.md @@ -14,7 +14,5 @@ This plugin allows you to run a single, lightweight, barebone WebSocket Server. ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/webengage/README.md b/docs/plugins/webengage/README.md index 3a8128157..1f591b962 100644 --- a/docs/plugins/webengage/README.md +++ b/docs/plugins/webengage/README.md @@ -14,7 +14,5 @@ Awesome Cordova Plugins wrapper that wraps Webengage Cordova plugin for Android ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/webim/README.md b/docs/plugins/webim/README.md index 02e30e0c3..19b8e1425 100644 --- a/docs/plugins/webim/README.md +++ b/docs/plugins/webim/README.md @@ -14,8 +14,6 @@ A cordova plugin, a JS version of Webim SDK ## Supported platforms - Android - - iOS - - Browser - - +- iOS +- Browser diff --git a/docs/plugins/wechat/README.md b/docs/plugins/wechat/README.md index aac91be2f..b5fc5487f 100644 --- a/docs/plugins/wechat/README.md +++ b/docs/plugins/wechat/README.md @@ -14,7 +14,5 @@ A cordova plugin, a JS version of Wechat SDK ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/wheel-selector/README.md b/docs/plugins/wheel-selector/README.md index e3c71d410..9b5a71531 100644 --- a/docs/plugins/wheel-selector/README.md +++ b/docs/plugins/wheel-selector/README.md @@ -1,12 +1,5 @@ # WheelSelector Plugin -- This plugin is still in beta stage and may not work as expected. Please - submit any issues to the plugin repo. -
- - ``` $ ionic cordova plugin add cordova-wheel-selector-plugin $ npm install @awesome-cordova-plugins/wheel-selector @@ -21,7 +14,5 @@ Native wheel selector for Cordova (Android/iOS). ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/wifi-wizard-2/README.md b/docs/plugins/wifi-wizard-2/README.md index 144e95334..80ace4c13 100644 --- a/docs/plugins/wifi-wizard-2/README.md +++ b/docs/plugins/wifi-wizard-2/README.md @@ -16,7 +16,5 @@ This project is a fork of the WifiWizard plugin with fixes and updates, as well ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/wonderpush/README.md b/docs/plugins/wonderpush/README.md index 03d7394b6..bbdcfab9c 100644 --- a/docs/plugins/wonderpush/README.md +++ b/docs/plugins/wonderpush/README.md @@ -1,5 +1,4 @@ -# UserPreferencesMethods -nderPush +# Push Notifications - WonderPush ``` $ ionic cordova plugin add wonderpush-cordova-sdk --variable CLIENT_ID=YOUR_CLIENT_ID --variable CLIENT_SECRET=YOUR_CLIENT_SECRET @@ -24,7 +23,5 @@ to retain your users and grow your audience while remaining fully GDPR compliant ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/youtube-video-player/README.md b/docs/plugins/youtube-video-player/README.md index c52a56b0f..e3fe1549e 100644 --- a/docs/plugins/youtube-video-player/README.md +++ b/docs/plugins/youtube-video-player/README.md @@ -14,7 +14,5 @@ Plays YouTube videos in Native YouTube App ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/zbar/README.md b/docs/plugins/zbar/README.md index 695809895..297872647 100644 --- a/docs/plugins/zbar/README.md +++ b/docs/plugins/zbar/README.md @@ -16,7 +16,5 @@ Requires Cordova plugin: `cordova-plugin-cszbar`. For more info, please see the ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/zeroconf/README.md b/docs/plugins/zeroconf/README.md index 1973717cd..450c6d56c 100644 --- a/docs/plugins/zeroconf/README.md +++ b/docs/plugins/zeroconf/README.md @@ -14,7 +14,5 @@ This plugin allows you to browse and publish Zeroconf/Bonjour/mDNS services. ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/zip/README.md b/docs/plugins/zip/README.md index cc5cf25be..af6a46caa 100644 --- a/docs/plugins/zip/README.md +++ b/docs/plugins/zip/README.md @@ -14,7 +14,5 @@ A Cordova plugin to unzip files in Android and iOS. ## Supported platforms - Android - - iOS - - +- iOS diff --git a/docs/plugins/zoom/README.md b/docs/plugins/zoom/README.md index 10fd19bd4..65c154872 100644 --- a/docs/plugins/zoom/README.md +++ b/docs/plugins/zoom/README.md @@ -14,7 +14,5 @@ A Cordova plugin to use Zoom Video Conferencing services on Cordova applications ## Supported platforms - Android - - iOS - - +- iOS diff --git a/scripts/docs/config.json b/scripts/docs/config.json deleted file mode 100644 index 4949e63a5..000000000 --- a/scripts/docs/config.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "v2DocsDir": "docs/native", - "pluginDir": "dist/@awesome-cordova-plugins/plugins" -} diff --git a/scripts/docs/dgeni/configs/links.js b/scripts/docs/dgeni/configs/links.js deleted file mode 100644 index 361b932c8..000000000 --- a/scripts/docs/dgeni/configs/links.js +++ /dev/null @@ -1,3 +0,0 @@ -module.exports = function (getLinkInfo) { - getLinkInfo.useFirstAmbiguousLink = false; -}; diff --git a/scripts/docs/dgeni/configs/log.js b/scripts/docs/dgeni/configs/log.js deleted file mode 100644 index cf20f3b26..000000000 --- a/scripts/docs/dgeni/configs/log.js +++ /dev/null @@ -1,3 +0,0 @@ -module.exports = function (log) { - log.level = 'error'; //'silly', 'debug', 'info', 'warn', 'error' -}; diff --git a/scripts/docs/dgeni/configs/tag-defs.js b/scripts/docs/dgeni/configs/tag-defs.js deleted file mode 100644 index ae47967b0..000000000 --- a/scripts/docs/dgeni/configs/tag-defs.js +++ /dev/null @@ -1,3 +0,0 @@ -module.exports = function (parseTagsProcessor) { - parseTagsProcessor.tagDefinitions = parseTagsProcessor.tagDefinitions.concat(require('../tag-defs/tag-defs')); -}; diff --git a/scripts/docs/dgeni/configs/template-filters.js b/scripts/docs/dgeni/configs/template-filters.js deleted file mode 100644 index 83f6a3d14..000000000 --- a/scripts/docs/dgeni/configs/template-filters.js +++ /dev/null @@ -1,12 +0,0 @@ -module.exports = function (templateEngine) { - // Nunjucks and Angular conflict in their template bindings so change the Nunjucks - // Also conflict with Jekyll - templateEngine.config.tags = { - variableStart: '<$', - variableEnd: '$>', - blockStart: '<@', - blockEnd: '@>', - commentStart: '<#', - commentEnd: '#>', - }; -}; diff --git a/scripts/docs/dgeni/configs/template-tags.js b/scripts/docs/dgeni/configs/template-tags.js deleted file mode 100644 index 53c8a8887..000000000 --- a/scripts/docs/dgeni/configs/template-tags.js +++ /dev/null @@ -1,9 +0,0 @@ -module.exports = function (templateEngine) { - // add custom filters to nunjucks - templateEngine.filters.push( - require('../filters/capital'), - require('../filters/code'), - require('../filters/dump'), - require('../filters/dashify') - ); -}; diff --git a/scripts/docs/dgeni/dgeni-config.js b/scripts/docs/dgeni/dgeni-config.js deleted file mode 100644 index 938036174..000000000 --- a/scripts/docs/dgeni/dgeni-config.js +++ /dev/null @@ -1,75 +0,0 @@ -'use strict'; -const Package = require('dgeni').Package, - jsdocPackage = require('dgeni-packages/jsdoc'), - nunjucksPackage = require('dgeni-packages/nunjucks'), - typescriptPackage = require('dgeni-packages/typescript'), - linksPackage = require('dgeni-packages/links'), - path = require('path'), - config = require('../config.json'); - -module.exports = (currentVersion) => { - return ( - new Package('ionic-native-docs', [jsdocPackage, nunjucksPackage, typescriptPackage, linksPackage]) - - .processor(require('./processors/remove-private-members')) - .processor(require('./processors/hide-private-api')) - .processor(require('./processors/parse-optional')) - .processor(require('./processors/mark-properties')) - .processor(require('./processors/npm-id')) - .processor(require('./processors/jekyll')) - - .config(require('./configs/log')) - .config(require('./configs/template-filters')) - .config(require('./configs/template-tags')) - .config(require('./configs/tag-defs')) - .config(require('./configs/links')) - - .config(function (renderDocsProcessor, computePathsProcessor) { - currentVersion = { - href: '/' + config.v2DocsDir.replace('content/', ''), - folder: '', - name: currentVersion, - }; - - renderDocsProcessor.extraData.version = { - list: [currentVersion], - current: currentVersion, - latest: currentVersion, - }; - - computePathsProcessor.pathTemplates = [ - { - docTypes: ['class'], - getOutputPath: (doc) => 'content/' + config.v2DocsDir + '/' + doc.name + '/index.md', - }, - ]; - }) - - //configure file reading - .config(function (readFilesProcessor, readTypeScriptModules) { - // Don't run unwanted processors since we are not using the normal file reading processor - readFilesProcessor.$enabled = false; - readFilesProcessor.basePath = path.resolve(__dirname, '../../..'); - - readTypeScriptModules.basePath = path.resolve(__dirname, '../../..'); - readTypeScriptModules.sourceFiles = ['./src/@awesome-cordova-plugins/plugins/**/*.ts']; - }) - - // Configure file writing - .config(function (writeFilesProcessor) { - writeFilesProcessor.outputFolder = '../ionic-site/'; - }) - - // Configure rendering - .config(function (templateFinder) { - templateFinder.templateFolders.unshift(path.resolve(__dirname, 'templates')); - - // Specify how to match docs to templates. - templateFinder.templatePatterns = [ - '${ doc.template }', - '${ doc.docType }.template.html', - 'common.template.html', - ]; - }) - ); -}; diff --git a/scripts/docs/dgeni/dgeni-readmes-config.js b/scripts/docs/dgeni/dgeni-readmes-config.js deleted file mode 100644 index 69fdad9e1..000000000 --- a/scripts/docs/dgeni/dgeni-readmes-config.js +++ /dev/null @@ -1,74 +0,0 @@ -'use strict'; -const Package = require('dgeni').Package, - jsdocPackage = require('dgeni-packages/jsdoc'), - nunjucksPackage = require('dgeni-packages/nunjucks'), - typescriptPackage = require('dgeni-packages/typescript'), - linksPackage = require('dgeni-packages/links'), - path = require('path'), - config = require('../config.json'); - -module.exports = (currentVersion) => { - return ( - new Package('ionic-native-readmes', [jsdocPackage, nunjucksPackage, typescriptPackage, linksPackage]) - - .processor(require('./processors/readmes')) - .processor(require('./processors/remove-private-members')) - .processor(require('./processors/hide-private-api')) - .processor(require('./processors/npm-id')) - - .config(require('./configs/log')) - .config(require('./configs/template-filters')) - .config(require('./configs/template-tags')) - .config(require('./configs/tag-defs')) - .config(require('./configs/links')) - - .config(function (renderDocsProcessor, computePathsProcessor) { - currentVersion = { - href: '/' + config.v2DocsDir.replace('content/', ''), - folder: '', - name: currentVersion, - }; - - renderDocsProcessor.extraData.version = { - list: [currentVersion], - current: currentVersion, - latest: currentVersion, - }; - - computePathsProcessor.pathTemplates = [ - { - docTypes: ['class'], - getOutputPath: (doc) => - doc.originalModule.replace(config.pluginDir + '/', '').replace(/\/index$/, '/README.md'), - }, - ]; - }) - - //configure file reading - .config(function (readFilesProcessor, readTypeScriptModules) { - // Don't run unwanted processors since we are not using the normal file reading processor - readFilesProcessor.$enabled = false; - readFilesProcessor.basePath = path.resolve(__dirname, '../../..'); - - readTypeScriptModules.basePath = path.resolve(path.resolve(__dirname, '../../..')); - readTypeScriptModules.sourceFiles = ['./src/@awesome-cordova-plugins/plugins/**/*.ts']; - }) - - // Configure file writing - .config(function (writeFilesProcessor) { - writeFilesProcessor.outputFolder = './dist/@awesome-cordova-plugins/'; - }) - - .config(function (writeFilesProcessor) { - writeFilesProcessor.outputFolder = './docs/'; - }) - - // Configure rendering - .config(function (templateFinder) { - templateFinder.templateFolders.unshift(path.resolve(__dirname, 'templates')); - - // Specify how to match docs to templates. - templateFinder.templatePatterns = ['${ doc.template }', '${ doc.docType }.template.md', 'readme.template.md']; - }) - ); -}; diff --git a/scripts/docs/dgeni/filters/capital.js b/scripts/docs/dgeni/filters/capital.js deleted file mode 100644 index 9d3c2bb5b..000000000 --- a/scripts/docs/dgeni/filters/capital.js +++ /dev/null @@ -1,5 +0,0 @@ -'use strict'; -module.exports = { - name: 'capital', - process: (str) => (str ? str.charAt(0).toUpperCase() + str.substring(1) : ''), -}; diff --git a/scripts/docs/dgeni/filters/code.js b/scripts/docs/dgeni/filters/code.js deleted file mode 100644 index 0ae001b3f..000000000 --- a/scripts/docs/dgeni/filters/code.js +++ /dev/null @@ -1,24 +0,0 @@ -'use strict'; -const encoder = new require('node-html-encoder').Encoder(); - -function code(str, inline, lang) { - // Encode any HTML entities in the code string - str = encoder.htmlEncode(str, true); - - // If a language is provided then attach a CSS class to the code element - lang = lang ? ' class="lang-' + lang + '"' : ''; - - str = '' + str + ''; - } - - return str; -} - -module.exports = { - name: 'code', - process: (str, lang) => code(str, true, lang), -}; diff --git a/scripts/docs/dgeni/filters/dashify.js b/scripts/docs/dgeni/filters/dashify.js deleted file mode 100644 index 60054c783..000000000 --- a/scripts/docs/dgeni/filters/dashify.js +++ /dev/null @@ -1,5 +0,0 @@ -'use strict'; -module.exports = { - name: 'dashify', - process: (str) => (str ? str.replace(/\s/g, '-') : ''), -}; diff --git a/scripts/docs/dgeni/filters/dump.js b/scripts/docs/dgeni/filters/dump.js deleted file mode 100644 index ad23b94c0..000000000 --- a/scripts/docs/dgeni/filters/dump.js +++ /dev/null @@ -1,5 +0,0 @@ -'use strict'; -module.exports = { - name: 'dump', - process: (obj) => console.log(obj), -}; diff --git a/scripts/docs/dgeni/processors/debug.js b/scripts/docs/dgeni/processors/debug.js deleted file mode 100644 index cc1f6af68..000000000 --- a/scripts/docs/dgeni/processors/debug.js +++ /dev/null @@ -1,39 +0,0 @@ -'use strict'; -module.exports = function test() { - return { - name: 'debug', - $runBefore: ['rendering-docs'], - $process: function (docs) { - docs.forEach(function (doc) { - if (doc.name == 'Camera') { - console.log(doc.tags); - doc.tags.forEach(function (tag) { - if (tag.tagName == 'classes') { - } - }); - - doc.moduleDoc.exports.forEach(function (d, i) { - if (d.name === 'CameraOptions') { - console.log('Name: ' + d.name); - console.log('Type: ' + d.docType); - console.log('First member: ', d.members[0]); - } - }); - - var exports = doc.exportSymbol.parent.exports; - for (var p in exports) { - if (p == 'CameraOptions') { - var x = exports[p]; - console.log(x.members.quality); - } - } - doc.members.forEach(function (method) { - if (method.name === 'getPicture') { - console.log(method); - } - }); - } - }); - }, - }; -}; diff --git a/scripts/docs/dgeni/processors/hide-private-api.js b/scripts/docs/dgeni/processors/hide-private-api.js deleted file mode 100644 index e58c8f71c..000000000 --- a/scripts/docs/dgeni/processors/hide-private-api.js +++ /dev/null @@ -1,9 +0,0 @@ -'use strict'; -module.exports = function removePrivateApi() { - return { - name: 'remove-private-api', - description: 'Prevent the private apis from being rendered', - $runBefore: ['rendering-docs'], - $process: (docs) => docs.filter((doc) => !doc.private && (!doc.tags || !doc.tags.tagsByName.get('hidden'))), - }; -}; diff --git a/scripts/docs/dgeni/processors/jekyll.js b/scripts/docs/dgeni/processors/jekyll.js deleted file mode 100644 index 6c9d46378..000000000 --- a/scripts/docs/dgeni/processors/jekyll.js +++ /dev/null @@ -1,63 +0,0 @@ -'use strict'; -module.exports = function jekyll(renderDocsProcessor) { - return { - name: 'jekyll', - description: 'Create jekyll includes', - $runAfter: ['paths-computed'], - $runBefore: ['rendering-docs'], - $process: (docs) => { - // pretty up and sort the docs object for menu generation - docs = docs.filter((doc) => (!!doc.name && !!doc.outputPath) || doc.docType === 'index-page'); - - docs.push({ - docType: 'class', - URL: 'https://github.com/ionic-team/ionic-native-google-maps/blob/master/documents/README.md', - name: 'Google Maps', - }); - - docs.sort((a, b) => { - const textA = a.name ? a.name.toUpperCase() : '', - textB = b.name ? b.name.toUpperCase() : ''; - - return textA < textB ? -1 : textA > textB ? 1 : 0; - }); - - docs.forEach((doc) => { - if (!doc.outputPath) { - return; - } - - doc.outputPath = doc.outputPath.toLowerCase().replace(/\s/g, '-'); - doc.URL = doc.outputPath.replace('docs//', 'docs/').replace('/index.md', '').replace('content/', ''); - // add trailing slash to plugin pages - if (!doc.URL.endsWith('/') && !doc.URL.endsWith('.html')) { - doc.URL = doc.URL + '/'; - } - - doc.URL = '/' + doc.URL; - }); - - const betaDocs = []; - - docs = docs.filter((doc) => { - if (doc.beta === true) { - betaDocs.push(doc); - return false; - } - return true; - }); - - docs = docs.concat(betaDocs); - - // add side menu - docs.push({ - docType: 'nativeMenu', - id: 'native_menu', - template: 'native_menu.template.html', - outputPath: 'content/_includes/fluid/native_menu.html', - }); - - return docs; - }, - }; -}; diff --git a/scripts/docs/dgeni/processors/mark-properties.js b/scripts/docs/dgeni/processors/mark-properties.js deleted file mode 100644 index 2b02528a7..000000000 --- a/scripts/docs/dgeni/processors/mark-properties.js +++ /dev/null @@ -1,16 +0,0 @@ -'use strict'; -module.exports = function markProperties() { - return { - name: 'mark-properties', - $runBefore: ['rendering-docs'], - $process: (docs) => - docs.map((doc) => { - for (let i in doc.members) { - if (doc.members.hasOwnProperty(i) && typeof doc.members[i].parameters === 'undefined') { - doc.members[i].isProperty = true; - } - } - return doc; - }), - }; -}; diff --git a/scripts/docs/dgeni/processors/npm-id.js b/scripts/docs/dgeni/processors/npm-id.js deleted file mode 100644 index 31394f27f..000000000 --- a/scripts/docs/dgeni/processors/npm-id.js +++ /dev/null @@ -1,20 +0,0 @@ -'use strict'; -module.exports = function npmId(renderDocsProcessor) { - return { - name: 'npm-id', - $runAfter: ['paths-computed'], - $runBefore: ['rendering-docs'], - $process: (docs) => { - // pretty up and sort the docs object for menu generation - docs = docs.filter(function (doc) { - return (!!doc.name && !!doc.outputPath) || doc.docType === 'index-page'; - }); - - docs.forEach((doc) => { - doc.npmId = doc.id.match(/plugins\/(.*)\/index/)[1]; - }); - - return docs; - }, - }; -}; diff --git a/scripts/docs/dgeni/processors/parse-optional.js b/scripts/docs/dgeni/processors/parse-optional.js deleted file mode 100644 index 9b38a2f73..000000000 --- a/scripts/docs/dgeni/processors/parse-optional.js +++ /dev/null @@ -1,22 +0,0 @@ -'use strict'; -module.exports = function parseOptional() { - return { - $runBefore: ['rendering-docs'], - $process: (docs) => { - docs.forEach((doc) => { - if (doc.members && doc.members.length) { - for (let i in doc.members) { - if (doc.members[i].params && doc.members[i].params.length) { - for (let ii in doc.members[i].params) { - if (doc.members[i].params[ii].optional) { - doc.members[i].params[ii].description += 'Optional'; - } - } - } - } - } - }); - return docs; - }, - }; -}; diff --git a/scripts/docs/dgeni/processors/readmes.js b/scripts/docs/dgeni/processors/readmes.js deleted file mode 100644 index 1f3cf38da..000000000 --- a/scripts/docs/dgeni/processors/readmes.js +++ /dev/null @@ -1,19 +0,0 @@ -'use strict'; -module.exports = function readmes(renderDocsProcessor) { - return { - name: 'readmes', - description: 'Create jekyll includes', - $runAfter: ['paths-computed'], - $runBefore: ['rendering-docs'], - $process: (docs) => { - // pretty up and sort the docs object for menu generation - docs = docs.filter((doc) => (!!doc.name && !!doc.outputPath) || doc.docType === 'index-page'); - - docs.forEach((doc) => { - doc.outputPath = doc.outputPath.replace('src/@awesome-cordova-plugins/', ''); - }); - - return docs; - }, - }; -}; diff --git a/scripts/docs/dgeni/processors/remove-private-members.js b/scripts/docs/dgeni/processors/remove-private-members.js deleted file mode 100644 index 2dd0b0a3c..000000000 --- a/scripts/docs/dgeni/processors/remove-private-members.js +++ /dev/null @@ -1,22 +0,0 @@ -'use strict'; -module.exports = function removePrivateMembers() { - return { - name: 'remove-private-members', - description: 'Remove member docs with @private tags', - $runAfter: ['tags-parsed'], - $runBefore: ['rendering-docs'], - $process: (docs) => { - docs.forEach((doc) => { - if (doc.members) { - doc.members = doc.members.filter((member) => !member.tags.tagsByName.get('hidden')); - } - - if (doc.statics) { - doc.statics = doc.statics.filter((staticMethod) => !staticMethod.tags.tagsByName.get('hidden')); - } - }); - - return docs; - }, - }; -}; diff --git a/scripts/docs/dgeni/tag-defs/tag-defs.js b/scripts/docs/dgeni/tag-defs/tag-defs.js deleted file mode 100644 index 3192824de..000000000 --- a/scripts/docs/dgeni/tag-defs/tag-defs.js +++ /dev/null @@ -1,11 +0,0 @@ -'use strict'; -module.exports = [ - { name: 'advanced' }, - { name: 'demo' }, - { name: 'beta', transforms: (doc, tag, value) => typeof value !== 'undefined' }, // make the value true or undefined instead of '' or undefined - { name: 'usage' }, - { name: 'hidden' }, // hide from docs - { name: 'classes' }, // related classes - { name: 'interfaces' }, // related interfaces - { name: 'paid', transforms: (doc, tag, value) => typeof value !== 'undefined' }, // paid plugin, set value to true -]; diff --git a/scripts/docs/dgeni/templates/common.template.html b/scripts/docs/dgeni/templates/common.template.html deleted file mode 100644 index ec70e3f9b..000000000 --- a/scripts/docs/dgeni/templates/common.template.html +++ /dev/null @@ -1,192 +0,0 @@ ---- -layout: "fluid/docs_base" -version: "<$ version.current.name $>" -versionHref: "<$ version.current.href.replace('content/','') $>" -path: "<$ doc.path $>" -category: native -id: "<$ doc.name|lower|replace(' ','-') $>" -title: "<@ if doc.docType == "directive" @><$ doc.name | dashCase $><@ else @><$ doc.name $><@ endif @>" -header_sub_title: "<$ doc.docType | capital $> in module <$ doc.module $>" -doc: "<$ doc.name $>" -docType: "<$ doc.docType $>" ---- - -<@- macro interfaceTable(interface) -@> <@ for export in doc.moduleDoc.exports -@> <@ if export.name == interface @> -
| Param | -Type | -Details | -
|---|---|---|
| <$ param.name $> | -
- <$ param.returnType | escape $>
- |
- <$ param.description | marked $> <@ if param.optional @>(optional)<@ endif @> | -
| <@ if isDirective @>Attr<@ else @>Param<@ endif @> | -Type | -Details | -
|---|---|---|
| <$ param.name $> <@- if param.alias @>| <$ param.alias $><@ endif -@> | -<$ typeList(param.typeList) $> | -
- <$ param.description | marked $> <@- if param.defaultValue @>
- (default: <$ param.defaultValue $>) - <@ endif -@> - |
-
<$ fn.name $><@- if not fn.isProperty @>(<@ endif -@><@- for param in fn.params @><$ sep() $> <@- if
- param.type.optional @>[<@- endif -@> <$ param.name $> <@- if param.type.optional -@>]<@- endif -@> <@- endfor -@><@-
- if not fn.isProperty @>)<@- endif -@>
-<@- endmacro -@> <@- macro typeList(types) -@> <@ set separator = joiner("|") @> <@- for type in types @><$ separator()
-$><$ type | code $><@ endfor -@> <@- endmacro -@> <@- macro typeInfo(fn) -@> <$ typeList(fn.typeList) $> <$
-fn.description $> <@- endmacro -@> <@- macro documentPlatforms(method) -@> <@- if method.decorators @> <@ for prop in
-method.decorators[0].argumentInfo @> <@ if prop.platforms @>
-- Platforms: - <@- for platform in prop.platforms -@> - <$ platform $> <@- endfor -@> -
-<@ endif @> <@ endfor @> <@- endif @> <@- endmacro -@> <@ macro documentMethod(method) -@> -- This plugin is still in beta stage and may not work as expected. Please submit any issues to the - plugin repo. -
-<@ endif @> <@ if doc.paid == true @> -- This plugin might require a paid license, or might take a share of your app's earnings. Check the - plugin's repo for more information. -
-<@ endif @> <# --- Plugin description --- #> <$ doc.description | marked $> - -- Repo: - <$ prop.repo $> -
- -<# --- Install commands --- #> -$ <@ if prop.install @><$ prop.install | replace('<', '<').replace('>', '>') $><@ else @>ionic cordova plugin add <$ prop.plugin $><@ endif @>
-$ npm install @ionic-native/<$ doc.npmId $>
-| Attribute | - <@ set hasTypes = false @> <@ for prop in doc.properties @> <@ if prop.type @> <@ set hasTypes = true @> <@ endif - @> <@ endfor @> <@ if hasTypes @> -Type | - <@ endif @> -Description | -
|---|---|---|
| <$ prop.name $> | - <@ if hasTypes @> -<$ prop.type.name $> | - <@ endif @> -<$ prop.description $> | -
- This plugin is still in beta stage and may not work as expected. Please - submit any issues to the plugin repo. -
-<@ endif -@> - -<@ for prop in doc.decorators[0].argumentInfo @> - -``` -$ <@ if prop.install @><$ prop.install $><@ else @>ionic cordova plugin add <$ prop.plugin $><@ endif @> -$ npm install @awesome-cordova-plugins/<$ doc.npmId|replace('plugins/','') $> -``` - -## [Usage Documentation](https://danielsogl.gitbook.io/awesome-cordova-plugins/plugins/<$ doc.fileInfo.relativePath|replace('/home/ubuntu/ionic-native/', '')|replace('//','/')|replace('index.ts','')|replace('src/@awesome-cordova-plugins/plugins/','') $>) - -Plugin Repo: [<$ prop.repo $>](<$ prop.repo $>) - -<$ doc.description $> - -<@- if prop.platforms @> - -## Supported platforms - -<@ for platform in prop.platforms -@> - -- <$ platform $> - <@ endfor @> - -<@ endif -@> - -<@ endfor @> diff --git a/scripts/docs/generate-readmes.ts b/scripts/docs/generate-readmes.ts new file mode 100644 index 000000000..ebc81a779 --- /dev/null +++ b/scripts/docs/generate-readmes.ts @@ -0,0 +1,257 @@ +import { + Application, + Converter, + Context, + ReflectionKind, + DeclarationReflection, + CommentTag, + ProjectReflection, + LogLevel, +} from 'typedoc'; +import { cpSync, mkdirSync, writeFileSync } from 'node:fs'; +import { resolve, join } from 'node:path'; +import { + Node, + Symbol as TsSymbol, + isClassDeclaration, + isCallExpression, + isIdentifier, + isObjectLiteralExpression, + isPropertyAssignment, + isStringLiteral, + isNumericLiteral, + isArrayLiteralExpression, + getDecorators, + SyntaxKind, +} from 'typescript'; + +const ROOT = resolve(__dirname, '../..'); +const PLUGINS_SRC = join(ROOT, 'src/@awesome-cordova-plugins/plugins'); +const DOCS_OUT = join(ROOT, 'docs/plugins'); + +interface PluginMeta { + pluginName?: string; + plugin?: string; + pluginRef?: string; + repo?: string; + platforms?: string[]; + install?: string; +} + +// Map from reflection id to extracted decorator metadata +const pluginMetaMap = new Map