mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2026-07-16 00:00:04 +08:00
chore(docs): fix readme generation
This commit is contained in:
@@ -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
|
||||
|
||||
+4
-1
@@ -224,7 +224,10 @@ docType: "<$ doc.docType $>"
|
||||
</p>
|
||||
<@ endif @>
|
||||
|
||||
<pre><code>$ <@ if prop.install @><$ prop.install $><@ else @>npm install @ionic-native/<$ prop.pluginRef $> -save<@ endif -@></code></pre>
|
||||
<pre><code>
|
||||
$ <@ if prop.install @><$ prop.install $><@ else @>ionic plugin add <$ prop.plugin $><@ endif -@>
|
||||
$ npm install --save @ionic-native/<$ prop.pluginRef $>
|
||||
</code></pre>
|
||||
<p>Repo:
|
||||
<a href="<$ prop.repo $>">
|
||||
<$ prop.repo $>
|
||||
|
||||
+15
-31
@@ -1,54 +1,38 @@
|
||||
<@- block body @>
|
||||
<@- block content @>
|
||||
<@- block header @>
|
||||
<a style="float:right;font-size:12px;" href="http://github.com/driftyco/ionic-native/edit/master/<$ doc.fileInfo.relativePath|replace('/home/ubuntu/ionic-native/', '')|replace('//','/') $>#L<$ doc.location.start.line $>">
|
||||
Improve this doc
|
||||
</a>
|
||||
|
||||
# <$ doc.name $>
|
||||
<!-- end header block -->
|
||||
<@ endblock -@>
|
||||
|
||||
<@- if doc.beta == true @>
|
||||
<p style="color:orange">
|
||||
This plugin is still in beta stage and may not work as expected. Please
|
||||
submit any issues to the <a target="_blank"
|
||||
href="<$ prop.repo $>/issues">plugin repo</a>.
|
||||
</p>
|
||||
<p style="color:orange">
|
||||
This plugin is still in beta stage and may not work as expected. Please
|
||||
submit any issues to the <a target="_blank"
|
||||
href="<$ prop.repo $>/issues">plugin repo</a>.
|
||||
</p>
|
||||
<@ 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 $>)
|
||||
|
||||
<!-- description -->
|
||||
<@- 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 @>
|
||||
<!-- @platforms tag -->
|
||||
|
||||
## Supported platforms
|
||||
<@ block platforms @>
|
||||
<@ for platform in prop.platforms -@>
|
||||
- <$ platform $>
|
||||
<@ endfor @>
|
||||
<@ endblock -@>
|
||||
<!-- @platforms tag end -->
|
||||
|
||||
<@ endif -@>
|
||||
<!-- end for prop in method.decorators[0].argumentInfo -->
|
||||
<@ endfor -@>
|
||||
<!-- end content block -->
|
||||
<@ endblock -@>
|
||||
<!-- end body block -->
|
||||
<@ endblock -@>
|
||||
|
||||
<@ endfor @>
|
||||
|
||||
Reference in New Issue
Block a user