diff --git a/scripts/docs/dgeni-readmes-config.js b/scripts/docs/dgeni-readmes-config.js index d681a2a16..2a58f85ea 100644 --- a/scripts/docs/dgeni-readmes-config.js +++ b/scripts/docs/dgeni-readmes-config.js @@ -19,8 +19,8 @@ module.exports = function(currentVersion) { // .processor(require('./processors/latest-version')) .processor(require('./processors/readmes')) -// .processor(require('./processors/remove-private-members')) -// .processor(require('./processors/hide-private-api')) +.processor(require('./processors/remove-private-members')) +.processor(require('./processors/hide-private-api')) // .processor(require('./processors/collect-inputs-outputs')) // for debugging docs diff --git a/scripts/docs/templates/common.template.html b/scripts/docs/templates/common.template.html index 5143e535f..79efbd3c3 100644 --- a/scripts/docs/templates/common.template.html +++ b/scripts/docs/templates/common.template.html @@ -224,7 +224,10 @@ docType: "<$ doc.docType $>"

<@ endif @> -
$ <@ if prop.install @><$ prop.install $><@ else @>npm install @ionic-native/<$ prop.pluginRef $> -save<@ endif -@>
+

+  $ <@ if prop.install @><$ prop.install $><@ else @>ionic plugin add <$ prop.plugin $><@ endif -@>
+  $ npm install --save @ionic-native/<$ prop.pluginRef $>
+

Repo: <$ prop.repo $> diff --git a/scripts/docs/templates/readme.template.md b/scripts/docs/templates/readme.template.md index 4cee741d2..44041c233 100644 --- a/scripts/docs/templates/readme.template.md +++ b/scripts/docs/templates/readme.template.md @@ -1,54 +1,38 @@ -<@- block body @> -<@- block content @> -<@- block header @> Improve this doc # <$ doc.name $> - -<@ endblock -@> <@- if doc.beta == true @> -

- This plugin is still in beta stage and may not work as expected. Please - submit any issues to the plugin repo. -

+

+ 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 @> + +<@ for prop in doc.decorators[0].argumentInfo @> + ``` -$ <@ if prop.install @><$ prop.install $><@ else @>npm install @ionic-native/<$ doc.npmId $> --save<@ endif @> +$ <@ if prop.install @><$ prop.install $><@ else @>ionic plugin add <$ prop.plugin $><@ endif @> +$ npm install --save @ionic-native/<$ doc.npmId $> ``` ## [Usage Documentation](https://ionicframework.com/docs/v2/native/<$ doc.fileInfo.relativePath|replace('/home/ubuntu/ionic-native/', '')|replace('//','/')|replace('index.ts','')|replace('src/@ionic-native/plugins/','') $>) -Cordova Repo: [<$ prop.repo $>](<$ prop.repo $>) +Plugin Repo: [<$ prop.repo $>](<$ prop.repo $>) - -<@- block description @> <$ doc.description $> -<@ endblock -@> - -<@- if doc.directiveInfo @> -## <$ doc.directiveInfo.type $> -### <$ doc.directiveInfo.properties[0].name $>: `<$ doc.directiveInfo.properties[0].values $>` -<@ endif -@> <@- if prop.platforms @> - + ## Supported platforms -<@ block platforms @> <@ for platform in prop.platforms -@> - <$ platform $> <@ endfor @> -<@ endblock -@> - + <@ endif -@> - -<@ endfor -@> - -<@ endblock -@> - -<@ endblock -@> + +<@ endfor @>