Merge pull request #1465 from piotrowski/improved-plugin-docs
docs(template): Improved plugin docs
This commit is contained in:
commit
6d4da1fff4
19
scripts/docs/templates/common.template.html
vendored
19
scripts/docs/templates/common.template.html
vendored
@ -164,18 +164,25 @@ docType: "<$ doc.docType $>"
|
|||||||
</p>
|
</p>
|
||||||
<@ endif @>
|
<@ endif @>
|
||||||
|
|
||||||
<# --- Install commands --- #>
|
<# --- Plugin description --- #>
|
||||||
<pre><code class="nohighlight">$ <@ if prop.install @><$ prop.install $><@ else @>ionic cordova plugin add <$ prop.plugin $><@ endif @>
|
<$ doc.description | marked $>
|
||||||
$ npm install --save @ionic-native/<$ doc.npmId $>
|
|
||||||
</code></pre>
|
|
||||||
<p>Repo:
|
<p>Repo:
|
||||||
<a href="<$ prop.repo $>">
|
<a href="<$ prop.repo $>">
|
||||||
<$ prop.repo $>
|
<$ prop.repo $>
|
||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<# --- Plugin description --- #>
|
<# --- Install commands --- #>
|
||||||
<$ doc.description | marked $>
|
<h2>Installation</h2>
|
||||||
|
<ol class="installation">
|
||||||
|
<li>Install the Cordova and Ionic Native plugins:<br>
|
||||||
|
<pre><code class="nohighlight">$ <@ if prop.install @><$ prop.install $><@ else @>ionic cordova plugin add <$ prop.plugin $><@ endif @>
|
||||||
|
$ npm install --save @ionic-native/<$ doc.npmId $>
|
||||||
|
</code></pre>
|
||||||
|
</li>
|
||||||
|
<li><a href="https://ionicframework.com/docs/native/#Add_Plugins_to_Your_App_Module">Add this plugin to your app's module</a></li>
|
||||||
|
</ol>
|
||||||
|
|
||||||
<# --- Plugin supported platforms --- #>
|
<# --- Plugin supported platforms --- #>
|
||||||
<@ if prop.platforms @>
|
<@ if prop.platforms @>
|
||||||
|
Loading…
x
Reference in New Issue
Block a user