From 8e65474c1d6b0c36af5a4bef228f30fcbf70b189 Mon Sep 17 00:00:00 2001 From: Jan Piotrowski Date: Sat, 29 Apr 2017 16:45:34 +0200 Subject: [PATCH 1/8] Add headline to install commands --- scripts/docs/templates/common.template.html | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/scripts/docs/templates/common.template.html b/scripts/docs/templates/common.template.html index 496ac51ec..92601581a 100644 --- a/scripts/docs/templates/common.template.html +++ b/scripts/docs/templates/common.template.html @@ -61,7 +61,7 @@ docType: "<$ doc.docType $>" <$ param.name $> - <@- if param.alias @>| <$ param.alias $><@ endif -@> + <@- if param.alias @>| <$ param.alias $><@ endif -@>f <$ typeList(param.typeList) $> @@ -165,6 +165,7 @@ docType: "<$ doc.docType $>" <@ endif @> <# --- Install commands --- #> +

Installation

$ <@ if prop.install @><$ prop.install $><@ else @>ionic plugin add --save <$ prop.plugin $><@ endif @>
 $ npm install --save @ionic-native/<$ doc.npmId $>
 
From 36d101af021ea0dc183d307479b1b1f174f1d573 Mon Sep 17 00:00:00 2001 From: Jan Piotrowski Date: Sat, 29 Apr 2017 16:47:23 +0200 Subject: [PATCH 2/8] remove stray "f" --- scripts/docs/templates/common.template.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/docs/templates/common.template.html b/scripts/docs/templates/common.template.html index 92601581a..d592fc3c0 100644 --- a/scripts/docs/templates/common.template.html +++ b/scripts/docs/templates/common.template.html @@ -61,7 +61,7 @@ docType: "<$ doc.docType $>" <$ param.name $> - <@- if param.alias @>| <$ param.alias $><@ endif -@>f + <@- if param.alias @>| <$ param.alias $><@ endif -@> <$ typeList(param.typeList) $> From 8a81ee08e34116b814985233afbdb4b05b4b9856 Mon Sep 17 00:00:00 2001 From: Jan Piotrowski Date: Fri, 5 May 2017 13:06:31 +0200 Subject: [PATCH 3/8] Switch placement of Description and Installation --- scripts/docs/templates/common.template.html | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/scripts/docs/templates/common.template.html b/scripts/docs/templates/common.template.html index d592fc3c0..e8e2a38c4 100644 --- a/scripts/docs/templates/common.template.html +++ b/scripts/docs/templates/common.template.html @@ -164,19 +164,20 @@ docType: "<$ doc.docType $>"

<@ endif @> -<# --- Install commands --- #> -

Installation

-
$ <@ if prop.install @><$ prop.install $><@ else @>ionic plugin add --save <$ prop.plugin $><@ endif @>
-$ npm install --save @ionic-native/<$ doc.npmId $>
-
+<# --- Plugin description --- #> +<$ doc.description | marked $> +

Repo: <$ prop.repo $>

-<# --- Plugin description --- #> -<$ doc.description | marked $> +<# --- Install commands --- #> +

Installation

+
$ <@ if prop.install @><$ prop.install $><@ else @>ionic plugin add --save <$ prop.plugin $><@ endif @>
+$ npm install --save @ionic-native/<$ doc.npmId $>
+
<# --- Plugin supported platforms --- #> <@ if prop.platforms @> From 49ac21145ae564e3801245610c4391cd22a062fc Mon Sep 17 00:00:00 2001 From: Jan Piotrowski Date: Fri, 5 May 2017 13:31:16 +0200 Subject: [PATCH 4/8] Add link to "Add this plugin to your app's module" and make Installation into ordered list --- scripts/docs/templates/common.template.html | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/scripts/docs/templates/common.template.html b/scripts/docs/templates/common.template.html index e8e2a38c4..ed7891054 100644 --- a/scripts/docs/templates/common.template.html +++ b/scripts/docs/templates/common.template.html @@ -175,9 +175,14 @@ docType: "<$ doc.docType $>" <# --- Install commands --- #>

Installation

-
$ <@ if prop.install @><$ prop.install $><@ else @>ionic plugin add --save <$ prop.plugin $><@ endif @>
+
    +
  1. Install the Cordova and Ionic Native plugins:
    +
    $ <@ if prop.install @><$ prop.install $><@ else @>ionic plugin add --save <$ prop.plugin $><@ endif @>
     $ npm install --save @ionic-native/<$ doc.npmId $>
     
    +
  2. +
  3. Add this plugin to your app's module
  4. +
<# --- Plugin supported platforms --- #> <@ if prop.platforms @> From 4835182ad5021036f7bd19ddd2d9860fc2796ab6 Mon Sep 17 00:00:00 2001 From: Jan Piotrowski Date: Fri, 5 May 2017 13:38:58 +0200 Subject: [PATCH 5/8] Replace inline styles with style block --- scripts/docs/templates/common.template.html | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/scripts/docs/templates/common.template.html b/scripts/docs/templates/common.template.html index ed7891054..14a5c187b 100644 --- a/scripts/docs/templates/common.template.html +++ b/scripts/docs/templates/common.template.html @@ -175,9 +175,18 @@ docType: "<$ doc.docType $>" <# --- Install commands --- #>

Installation

-
    -
  1. Install the Cordova and Ionic Native plugins:
    -
    $ <@ if prop.install @><$ prop.install $><@ else @>ionic plugin add --save <$ prop.plugin $><@ endif @>
    +
    +
      +
    1. Install the Cordova and Ionic Native plugins:
      +
      $ <@ if prop.install @><$ prop.install $><@ else @>ionic plugin add --save <$ prop.plugin $><@ endif @>
       $ npm install --save @ionic-native/<$ doc.npmId $>
       
    2. From e193baf1c1e7be7ddc44cf6dcb52747f010c431d Mon Sep 17 00:00:00 2001 From: Jan Piotrowski Date: Thu, 11 May 2017 11:33:19 +0200 Subject: [PATCH 6/8] Removed inline style block (as it was added to the main site css) --- scripts/docs/templates/common.template.html | 9 --------- 1 file changed, 9 deletions(-) diff --git a/scripts/docs/templates/common.template.html b/scripts/docs/templates/common.template.html index 14a5c187b..fdf82ff1a 100644 --- a/scripts/docs/templates/common.template.html +++ b/scripts/docs/templates/common.template.html @@ -175,15 +175,6 @@ docType: "<$ doc.docType $>" <# --- Install commands --- #>

      Installation

      -
      1. Install the Cordova and Ionic Native plugins:
        $ <@ if prop.install @><$ prop.install $><@ else @>ionic plugin add --save <$ prop.plugin $><@ endif @>
        
        From dea9f42d5fe513ea38376f7a62db9128d1e9e43d Mon Sep 17 00:00:00 2001
        From: Jan Piotrowski 
        Date: Thu, 11 May 2017 17:53:15 +0200
        Subject: [PATCH 7/8] Changed `ionic plugin`to `ionic cordova plugin`
        
        ---
         scripts/docs/templates/common.template.html | 2 +-
         1 file changed, 1 insertion(+), 1 deletion(-)
        
        diff --git a/scripts/docs/templates/common.template.html b/scripts/docs/templates/common.template.html
        index fdf82ff1a..2a78c67d0 100644
        --- a/scripts/docs/templates/common.template.html
        +++ b/scripts/docs/templates/common.template.html
        @@ -177,7 +177,7 @@ docType: "<$ doc.docType $>"
         

        Installation

        1. Install the Cordova and Ionic Native plugins:
          -
          $ <@ if prop.install @><$ prop.install $><@ else @>ionic plugin add --save <$ prop.plugin $><@ endif @>
          +    
          $ <@ if prop.install @><$ prop.install $><@ else @>ionic cordova plugin add --save <$ prop.plugin $><@ endif @>
           $ npm install --save @ionic-native/<$ doc.npmId $>
           
        2. From 7d4e8acce8d3e7dab58922cabd25cac0b87d7f43 Mon Sep 17 00:00:00 2001 From: Jan Piotrowski Date: Wed, 17 May 2017 11:31:41 +0200 Subject: [PATCH 8/8] Remove `--save` `ionic cordova plugin add` always adds `--save` to the Cordova call anyway --- scripts/docs/templates/common.template.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/docs/templates/common.template.html b/scripts/docs/templates/common.template.html index 2a78c67d0..4f08337c6 100644 --- a/scripts/docs/templates/common.template.html +++ b/scripts/docs/templates/common.template.html @@ -177,7 +177,7 @@ docType: "<$ doc.docType $>"

          Installation

          1. Install the Cordova and Ionic Native plugins:
            -
            $ <@ if prop.install @><$ prop.install $><@ else @>ionic cordova plugin add --save <$ prop.plugin $><@ endif @>
            +    
            $ <@ if prop.install @><$ prop.install $><@ else @>ionic cordova plugin add <$ prop.plugin $><@ endif @>
             $ npm install --save @ionic-native/<$ doc.npmId $>