feat(pages): anchor for name of variables and functions

compodoc · Sep 8, 2017 · d9869a6 · d9869a6
1 parent 104b82f
commit d9869a6
Show file tree

Hide file tree

Showing 11 changed files with 38 additions and 11 deletions.
diff --git a/dist/index-cli.js b/dist/index-cli.js
@@ -860,6 +860,12 @@ var HtmlEngineHelpers = (function () {
             }
             return options.inverse(this);
         });
+        Handlebars.registerHelper("ifString", function (a, options) {
+            if (typeof a === 'string') {
+                return options.fn(this);
+            }
+            return options.inverse(this);
+        });
         Handlebars.registerHelper("orLength", function () {
             var len = arguments.length - 1;
             var options = arguments[len];

diff --git a/dist/index.js b/dist/index.js
@@ -860,6 +860,12 @@ var HtmlEngineHelpers = (function () {
             }
             return options.inverse(this);
         });
+        Handlebars.registerHelper("ifString", function (a, options) {
+            if (typeof a === 'string') {
+                return options.fn(this);
+            }
+            return options.inverse(this);
+        });
         Handlebars.registerHelper("orLength", function () {
             var len = arguments.length - 1;
             var options = arguments[len];

diff --git a/src/app/engines/html.engine.helpers.ts b/src/app/engines/html.engine.helpers.ts
@@ -54,6 +54,12 @@ export let HtmlEngineHelpers = (function() {
 
           return options.inverse(this);
         });
+        Handlebars.registerHelper("ifString", function(a, options) {
+            if (typeof a === 'string') {
+              return options.fn(this);
+            }
+            return options.inverse(this);
+        });
         Handlebars.registerHelper("orLength", function(/* any, any, ..., options */) {
             var len = arguments.length - 1;
           var options = arguments[len];

diff --git a/src/resources/styles/compodoc.css b/src/resources/styles/compodoc.css
@@ -757,3 +757,12 @@ ul.index-list {
     height: 175px;
     line-height: 175px;
 }
+
+.name a {
+    display: none;
+    color: #6e6e6e;
+    margin-left: 5px;
+}
+.name:hover a {
+    display: inline-block;
+}
diff --git a/src/templates/partials/block-enum.hbs b/src/templates/partials/block-enum.hbs
@@ -5,7 +5,7 @@
                 <tr>
                     <td class="col-md-4">
                         <a name="{{name}}"></a>
-                        <b>{{name}}</b>
+                        <span class="name"><b>{{name}}</b><a href="#{{name}}"><span class="fa fa-link"></span></a></span>
                     </td>
                 </tr>
                 {{#if description}}

diff --git a/src/templates/partials/block-method.hbs b/src/templates/partials/block-method.hbs
@@ -1,16 +1,16 @@
 <section>
-    {{#if title}}{{else}}
+    {{#ifString title}}<h3>{{title}}</h3>{{else}}
         <h3 id="methods">
             Methods
         </h3>
-    {{/if}}
+    {{/ifString}}
     {{#each methods}}
         <table class="table table-sm table-bordered">
             <tbody>
                 <tr>
                     <td class="col-md-4">
                         <a name="{{name}}"></a>
-                        <b>{{#if modifierKind}}<span class="modifier">{{modifKind modifierKind}}</span>{{/if}} {{name}}</b>
+                        <span class="name"><b>{{#if modifierKind}}<span class="modifier">{{modifKind modifierKind}}</span>{{/if}} {{name}}</b><a href="#{{name}}"><span class="fa fa-link"></span></a></span>
                     </td>
                 </tr>
                 {{#if ../file-path}}

diff --git a/src/templates/partials/block-property.hbs b/src/templates/partials/block-property.hbs
@@ -1,16 +1,16 @@
 <section>
-    {{#if title}}{{else}}
+    {{#ifString title}}<h3>{{title}}</h3>{{else}}
         <h3 id="inputs">
             Properties
         </h3>
-    {{/if}}
+    {{/ifString}}
     {{#each properties}}
         <table class="table table-sm table-bordered">
             <tbody>
                 <tr>
                     <td class="col-md-4">
                         <a name="{{name}}"></a>
-                        <b>{{#if modifierKind}}<span class="modifier">{{modifKind modifierKind}}</span>{{/if}} {{name}}</b>
+                        <span class="name"><b>{{#if modifierKind}}<span class="modifier">{{modifKind modifierKind}}</span>{{/if}} {{name}}</b><a href="#{{name}}"><span class="fa fa-link"></span></a></span>
                     </td>
                 </tr>
                 {{#if ../file-path}}

diff --git a/src/templates/partials/block-typealias.hbs b/src/templates/partials/block-typealias.hbs
@@ -5,7 +5,7 @@
                 <tr>
                     <td class="col-md-4">
                         <a name="{{name}}"></a>
-                        <b>{{name}}</b>
+                        <span class="name"><b>{{name}}</b><a href="#{{name}}"><span class="fa fa-link"></span></a></span>
                     </td>
                 </tr>
                 {{#if description}}

diff --git a/src/templates/partials/interface.hbs b/src/templates/partials/interface.hbs
@@ -116,7 +116,7 @@
                                 <tr>
                                     <td class="col-md-4">
                                         <a name="{{name}}"></a>
-                                        <b>{{name}}</b>
+                                        <span class="name"><b>{{name}}</b><a href="#{{name}}"><span class="fa fa-link"></span></a></span>
                                     </td>
                                 </tr>
                                 <tr>

diff --git a/src/templates/partials/miscellaneous-functions.hbs b/src/templates/partials/miscellaneous-functions.hbs
@@ -6,5 +6,5 @@
 
 {{#each miscellaneous.groupedFunctions}}
     <h3>{{@key}}</h3>
-    {{> block-method methods=this title='false'}}
+    {{> block-method methods=this title=''}}
 {{/each}}
diff --git a/src/templates/partials/miscellaneous-variables.hbs b/src/templates/partials/miscellaneous-variables.hbs
@@ -6,5 +6,5 @@
 
 {{#each miscellaneous.groupedVariables}}
     <h3>{{@key}}</h3>
-    {{> block-property properties=this title='false'}}
+    {{> block-property properties=this title=''}}
 {{/each}}