Added new footer and analytics

Author: sebastian-lenz

README.md

@@ -87,6 +87,18 @@ Define a pattern for files that should be considered being external.
 
 Prevent externally resolved TypeScript files from being documented.
 
+`--gaID`
+
+Set the Google Analytics tracking ID and activate tracking code.
+
+`--gaSite <site>`
+
+Set the site name for Google Analytics. Defaults to `auto`.
+
+`--hideGenerator`
+
+Do not print the TypeDoc link at the end of the page.
+
 `--verbose`
 
 Print more information while TypeDoc is running.

bin/themes/default/assets/css/main.css

@@ -1,5 +1,3 @@
-.tsd-page-toolbar { box-shadow: 0 0 4px rgba(0, 0, 0, 0.5); }
-
 /*! normalize.css v1.1.3 | MIT License | git.io/normalize */
 /* ========================================================================== HTML5 display definitions ========================================================================== */
 /* Correct `block` display not defined in IE 6/7/8/9 and Firefox 3. */
@@ -243,7 +241,7 @@ table { border-collapse: collapse; border-spacing: 0; }
 .offset-11 { margin-left: 91.66667%; }
 
 .tsd-kind-icon { display: block; position: relative; padding-left: 20px; text-indent: -20px; }
-.tsd-kind-icon:before { content: ''; display: inline-block; vertical-align: middle; width: 17px; height: 17px; margin-right: 3px; background-image: url(../images/icons.png); }
+.tsd-kind-icon:before { content: ''; display: inline-block; vertical-align: middle; width: 17px; height: 17px; margin: 0 3px 2px 0; background-image: url(../images/icons.png); }
 @media (-webkit-min-device-pixel-ratio: 1.5), (min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { .tsd-kind-icon:before { background-image: url(../images/icons@2x.png); background-size: 187px 102px; } }
 
 .tsd-kind-acceptable-alias > .tsd-kind-icon:before { background-position: -0px 0; }
@@ -473,12 +471,15 @@ pre code { padding: 0; font-size: 100%; background-color: transparent; }
 .tsd-typography h5, .tsd-typography h6 { font-weight: normal; }
 .tsd-typography p, .tsd-typography ul, .tsd-typography ol { margin: 0 0 1em 0; }
 
+@media (min-width: 769px) and (max-width: 1024px) { html.default .col-content { width: 72%; }
+  html.default .col-menu { width: 28%; }
+  html.default .tsd-navigation { padding-left: 10px; } }
 @media (max-width: 768px) { html.default .col-content { float: none; width: 100%; }
   html.default .col-menu { position: fixed !important; overflow: auto; -webkit-overflow-scrolling: touch; overflow-scrolling: touch; z-index: 1024; top: 0 !important; bottom: 0 !important; left: auto !important; right: 0 !important; width: 100%; padding: 20px 20px 20px 0; max-width: 450px; visibility: hidden; background-color: white; box-shadow: inset 0 0 4px rgba(0, 0, 0, 0.5); }
   html.default.has-menu header, html.default.has-menu .col-content { -webkit-transform: translate(-50%, 0); -ms-transform: translate(-50%, 0); transform: translate(-50%, 0); }
   html.default.has-menu .col-menu { visibility: visible; } }
 
-.tsd-page-title { padding: 70px 0 20px 0; margin: 0 0 20px 0; background: white; box-shadow: 0 0 4px rgba(0, 0, 0, 0.5); }
+.tsd-page-title { padding: 70px 0 20px 0; margin: 0 0 40px 0; background: white; box-shadow: 0 0 4px rgba(0, 0, 0, 0.5); }
 .tsd-page-title h1 { margin: 0; }
 
 .tsd-breadcrumb { margin: 0; padding: 0; color: gray; }
@@ -490,15 +491,17 @@ pre code { padding: 0; font-size: 100%; background-color: transparent; }
 html.minimal .container { margin: 0; }
 html.minimal .container-main { padding-top: 50px; }
 html.minimal .content-wrap { padding-left: 300px; }
-html.minimal .tsd-navigation { position: fixed; overflow: auto; -moz-box-sizing: border-box; box-sizing: border-box; z-index: 1; left: 0; top: 40px; bottom: 0; width: 300px; padding: 20px; margin: 0; background-color: #eeeeee; }
+html.minimal .tsd-navigation { position: fixed !important; overflow: auto; overflow-scrolling: touch; -moz-box-sizing: border-box; box-sizing: border-box; z-index: 1; left: 0; top: 40px; bottom: 0; width: 300px; padding: 20px; margin: 0; }
 html.minimal .tsd-member .tsd-member { margin-left: 0; }
+html.minimal .tsd-page-toolbar { position: fixed; z-index: 2; }
 
 dl.tsd-comment-tags { overflow: hidden; }
 dl.tsd-comment-tags dt { clear: both; float: left; padding: 1px 5px; margin: 0 10px 0 0; border-radius: 4px; border: 1px solid #999999; color: #999999; font-size: 0.8em; font-weight: normal; }
 dl.tsd-comment-tags dd { margin: 0 0 10px 0; }
 dl.tsd-comment-tags p { margin: 0; }
 
 .tsd-panel.tsd-comment .lead { font-size: 1.1em; line-height: 1.333em; margin-bottom: 2em; }
+.tsd-panel.tsd-comment .lead:last-child { margin-bottom: 0; }
 
 .toggle-inherited .tsd-is-inherited { display: none; }
 
@@ -518,10 +521,15 @@ dl.tsd-comment-tags p { margin: 0; }
 @media (-webkit-min-device-pixel-ratio: 1.5), (min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { #tsd-filter input:checked + label:before { background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABYAAAAWCAMAAADzapwJAAAAbFBMVEX///8zMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMGjw0YAAAAI3RSTlMAAHd5drsP6/x6EXg5HQa9tHTD6qM0ewSp5jcHsgu/EMG+fFYgEsoAAAB3SURBVHhetc1HFsMgDEVRf+PaS3ov2v8eDRKEE5Ipb6Y7+Erihu9U3vzhmWj85YyIKuZQqRYeeqepUQXmYio70VZUeCHasCujLSxv9VHugD3vwvHhqP105m8pPozLVUNl1TNuuSannlHcRQPG48kaMprXG56jtgI0cQrrsMDSOQAAAABJRU5ErkJggg==); } }
 #tsd-filter input:checked + label:hover { opacity: 1; }
 
+footer { border-top: 1px solid #ebebeb; border-bottom: 1px solid #ebebeb; background-color: white; }
+footer .tsd-legend-group { font-size: 0; }
+footer .tsd-legend { display: inline-block; width: 25%; padding: 0; font-size: 16px; list-style: none; line-height: 1.333em; vertical-align: top; }
+@media (max-width: 768px) { footer .tsd-legend { width: 50%; } }
+
 .tsd-hierarchy { list-style: square; padding: 0 0 0 20px; margin: 0; }
 .tsd-hierarchy .target { font-weight: bold; }
 
-.tsd-index-panel .tsd-index-content { margin-bottom: -30px; }
+.tsd-index-panel .tsd-index-content { margin-bottom: -30px !important; }
 .tsd-index-panel .tsd-index-section { margin-bottom: 30px !important; }
 .tsd-index-panel h3 { margin: 0 -20px 10px -20px; padding: 0 20px 10px 20px; border-bottom: 1px solid #eeeeee; }
 .tsd-index-panel ul.tsd-index-list { -webkit-column-count: 3; -moz-column-count: 3; -ms-column-count: 3; column-count: 3; -webkit-column-gap: 20px; -moz-column-gap: 20px; -ms-column-gap: 20px; column-gap: 20px; padding: 0; list-style: none; line-height: 1.333em; }
@@ -640,7 +648,7 @@ dl.tsd-comment-tags p { margin: 0; }
 .tsd-sources ul, .tsd-sources p { margin: 0 !important; }
 .tsd-sources ul { list-style: none; padding: 0; }
 
-.tsd-page-toolbar { position: absolute; z-index: 1; top: 0; left: 0; width: 100%; height: 40px; color: #333333; background: white; }
+.tsd-page-toolbar { position: absolute; z-index: 1; top: 0; left: 0; width: 100%; height: 40px; color: #333333; background: white; border-bottom: 1px solid #ebebeb; }
 .tsd-page-toolbar a { color: #333333; font-weight: bold; text-decoration: none; }
 .tsd-page-toolbar a:hover { text-decoration: underline; }
 .tsd-page-toolbar .table-wrap { display: table; width: 100%; height: 40px; }

bin/themes/default/assets/js/main.js

@@ -3,7 +3,7 @@
 <head>
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
-    <title>{{model.name}} | {{project.name}}</title>
+    <title>{{#ifCond model.name '==' project.name}}{{project.name}}{{else}}{{model.name}} | {{project.name}}{{/ifCond}}</title>
     <meta name="description" content="">
     <meta name="viewport" content="width=device-width, initial-scale=1">
 
@@ -37,8 +37,10 @@
                     <input type="checkbox" id="tsd-filter-private" checked />
                     <label for="tsd-filter-private">Private</label>
 
-                    <input type="checkbox" id="tsd-filter-externals" checked />
-                    <label for="tsd-filter-externals">Externals</label>
+                    {{#unless settings.excludeExternals}}
+                        <input type="checkbox" id="tsd-filter-externals" checked />
+                        <label for="tsd-filter-externals">Externals</label>
+                    {{/unless}}
 
                     <input type="checkbox" id="tsd-filter-only-exported" />
                     <label for="tsd-filter-only-exported">Only exported</label>
@@ -84,44 +86,67 @@
 <footer>
     <div class="container">
         <h2>Legend</h2>
-        <span class="tsd-kind-container"><span class="tsd-kind-icon">Container, dynamic module</span></span>
-        <span class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></span>
-        <span class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></span>
-        <span class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></span>
-        <span class="tsd-kind-property"><span class="tsd-kind-icon">Variable</span></span>
-        <span class="tsd-kind-call-signature"><span class="tsd-kind-icon">Function, call signature, accessor</span></span>
-        <span class="tsd-kind-construct-signature"><span class="tsd-kind-icon">Constructor</span></span>
-        <span class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></span>
-
-        <h3>Interface members</h3>
-        <span class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></span>
-        <span class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></span>
-        <span class="tsd-kind-call-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Member, accessor</span></span>
-        <span class="tsd-kind-construct-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></span>
-        <span class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></span>
-
-        <h3>Class members</h3>
-        <span class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></span>
-        <span class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></span>
-        <span class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></span>
-        <span class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></span>
-        <span class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></span>
-        <span class="tsd-kind-call-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Member, accessor</span></span>
-        <span class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited member</span></span>
-        <span class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private member</span></span>
-        <span class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static member</span></span>
-        <span class="tsd-kind-construct-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></span>
-        <span class="tsd-kind-construct-signature tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></span>
-        <span class="tsd-kind-construct-signature tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private constructor</span></span>
-        <span class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></span>
-    </div>
-    <div class="container">
-        <p>Generated with <a href="http://typedoc.io" target="_blank">TypeDoc</a></p>
+        <div class="tsd-legend-group">
+            <ul class="tsd-legend">
+                <li class="tsd-kind-container"><span class="tsd-kind-icon">Container, dynamic module</span></li>
+            </ul>
+            <ul class="tsd-legend">
+                <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
+                <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
+            </ul>
+            <ul class="tsd-legend">
+                <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
+                <li class="tsd-kind-construct-signature"><span class="tsd-kind-icon">Constructor</span></li>
+                <li class="tsd-kind-property"><span class="tsd-kind-icon">Variable</span></li>
+                <li class="tsd-kind-call-signature"><span class="tsd-kind-icon">Function, call signature, accessor</span></li>
+                <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
+            </ul>
+            <ul class="tsd-legend">
+                <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
+                <li class="tsd-kind-construct-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
+                <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
+                <li class="tsd-kind-call-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Member, accessor</span></li>
+                <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
+            </ul>
+            <ul class="tsd-legend">
+                <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
+                <li class="tsd-kind-construct-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
+                <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
+                <li class="tsd-kind-call-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Member, accessor</span></li>
+                <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
+            </ul>
+            <ul class="tsd-legend">
+                <li>&nbsp;</li>
+                <li class="tsd-kind-construct-signature tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
+                <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
+                <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited member</span></li>
+            </ul>
+            <ul class="tsd-legend">
+                <li>&nbsp;</li>
+                <li class="tsd-kind-construct-signature tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private constructor</span></li>
+                <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
+                <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private member</span></li>
+            </ul>
+            <ul class="tsd-legend">
+                <li>&nbsp;</li>
+                <li>&nbsp;</li>
+                <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
+                <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static member</span></li>
+            </ul>
+        </div>
     </div>
 </footer>
 
+{{#unless settings.hideGenerator}}
+    <div class="container tsd-generator">
+        <p>Generated using <a href="http://typedoc.io" target="_blank">TypeDoc</a></p>
+    </div>
+{{/unless}}
+
 <script src="{{relativeURL "assets/js/main.js"}}"></script>
 <script>if (location.protocol == 'file:') document.write('<script src="{{relativeURL "assets/js/search.js"}}"><' + '/script>');</script>
 
+{{> analytics}}
+
 </body>
 </html>

bin/themes/default/layouts/default.hbs

@@ -0,0 +1,11 @@
+{{#if settings.googleAnalyticsID}}
+    <script>
+        (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+            (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+                m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+        })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+        ga('create', '{{settings.googleAnalyticsID}}', '{{settings.googleAnalyticsSite}}');
+        ga('send', 'pageview');
+    </script>
+{{/if}}