Build documentation [ci skip]

Haroenv · Jun 9, 2017 · 1330e0d · 1330e0d
1 parent 35aeab8
commit 1330e0d
Show file tree

Hide file tree

Showing 9 changed files with 89 additions and 260 deletions.
diff --git a/doc/css/jsdoc-default.css b/doc/css/jsdoc-default.css
@@ -427,7 +427,7 @@ h1, h2, h3, h4, h5, h6 {
     text-transform: initial;
     margin: 0;
     padding: .5rem 1rem;
-    font-family: Monaco, Consolas, monospace;
+    font-family: Monacco, Consolas, monospace;
     font-weight: normal;
     border-radius: 2px;
     background-color: #f7f7f7;
@@ -605,7 +605,7 @@ table {
     .main-nav li li > a {
       padding-left: 2rem;
       font-weight: normal;
-      font-family: Monaco, Consolas, monospace; }
+      font-family: Monacco, Consolas, monospace; }
       .main-nav li li > a:before {
         -webkit-transform: scale(0.1, 1);
                 transform: scale(0.1, 1); }
@@ -755,7 +755,7 @@ dl {
   margin: 2rem 1rem;
   box-shadow: 0 1px 2px rgba(0, 0, 0, 0.2), 0 2px 3px rgba(0, 0, 0, 0.35); }
   .card > h2 {
-    font-family: Monaco, Consolas, monospace; }
+    font-family: Monacco, Consolas, monospace; }
 
 .__tag {
   display: -webkit-inline-box;
@@ -775,7 +775,7 @@ dl {
   border-radius: 2px;
   vertical-align: baseline;
   font-size: 0.5rem;
-  font-family: Monaco, Consolas, monospace;
+  font-family: Monacco, Consolas, monospace;
   line-height: 1;
   font-weight: bold;
   box-shadow: 0 1px 2px rgba(0, 0, 0, 0.4);
@@ -787,6 +787,7 @@ dl {
     padding: 0.5em 1.5em;
     border-radius: inherit;
     color: currentColor;
+    width: calc(100% + 3em);
     overflow: hidden;
     text-overflow: ellipsis;
     white-space: nowrap; }
@@ -963,7 +964,7 @@ ol.linenums {
   margin-bottom: 0; }
 
 code {
-  font-family: Monaco, Consolas, monospace;
+  font-family: Monacco, Consolas, monospace;
   padding: 0 .5em;
   background: #fff;
   color: #000;
@@ -982,7 +983,7 @@ pre {
 
 .prettyprint {
   background: #fff;
-  font-family: Monaco, Consolas, monospace; }
+  font-family: Menlo, "Bitstream Vera Sans Mono", "DejaVu Sans Mono", Monaco, Consolas, monospace; }
   .prettyprint.linenums {
     padding: 0; }
 

diff --git a/doc/holmes.html b/doc/holmes.html
@@ -853,7 +853,7 @@ <h3 class="subsection-title">Members</h3>
 <section class="code-source">
   <div class="link-box">
 
-    <a href="main.js.html">main.js</a> <a href="main.js.html#line131">line 131</a>
+    <a href="main.js.html">main.js</a> <a href="main.js.html#line143">line 143</a>
 
   </div>
 </section>
@@ -934,7 +934,7 @@ <h5>Type:</h5>
 <section class="code-source">
   <div class="link-box">
 
-    <a href="main.js.html">main.js</a> <a href="main.js.html#line375">line 375</a>
+    <a href="main.js.html">main.js</a> <a href="main.js.html#line393">line 393</a>
 
   </div>
 </section>
@@ -1017,7 +1017,7 @@ <h5>Type:</h5>
 <section class="code-source">
   <div class="link-box">
 
-    <a href="main.js.html">main.js</a> <a href="main.js.html#line367">line 367</a>
+    <a href="main.js.html">main.js</a> <a href="main.js.html#line385">line 385</a>
 
   </div>
 </section>
@@ -1100,7 +1100,7 @@ <h5>Type:</h5>
 <section class="code-source">
   <div class="link-box">
 
-    <a href="main.js.html">main.js</a> <a href="main.js.html#line117">line 117</a>
+    <a href="main.js.html">main.js</a> <a href="main.js.html#line129">line 129</a>
 
   </div>
 </section>
@@ -1183,7 +1183,7 @@ <h5>Type:</h5>
 <section class="code-source">
   <div class="link-box">
 
-    <a href="main.js.html">main.js</a> <a href="main.js.html#line125">line 125</a>
+    <a href="main.js.html">main.js</a> <a href="main.js.html#line137">line 137</a>
 
   </div>
 </section>
@@ -1264,7 +1264,7 @@ <h5>Type:</h5>
 <section class="code-source">
   <div class="link-box">
 
-    <a href="main.js.html">main.js</a> <a href="main.js.html#line109">line 109</a>
+    <a href="main.js.html">main.js</a> <a href="main.js.html#line121">line 121</a>
 
   </div>
 </section>
@@ -1343,7 +1343,7 @@ <h5>Type:</h5>
 <section class="code-source">
   <div class="link-box">
 
-    <a href="main.js.html">main.js</a> <a href="main.js.html#line137">line 137</a>
+    <a href="main.js.html">main.js</a> <a href="main.js.html#line149">line 149</a>
 
   </div>
 </section>
@@ -1424,7 +1424,7 @@ <h5>Type:</h5>
 <section class="code-source">
   <div class="link-box">
 
-    <a href="main.js.html">main.js</a> <a href="main.js.html#line143">line 143</a>
+    <a href="main.js.html">main.js</a> <a href="main.js.html#line155">line 155</a>
 
   </div>
 </section>
@@ -1507,7 +1507,7 @@ <h5>Type:</h5>
 <section class="code-source">
   <div class="link-box">
 
-    <a href="main.js.html">main.js</a> <a href="main.js.html#line168">line 168</a>
+    <a href="main.js.html">main.js</a> <a href="main.js.html#line180">line 180</a>
 
   </div>
 </section>
@@ -1596,7 +1596,7 @@ <h3 class="subsection-title">Methods</h3>
 <section class="code-source">
   <div class="link-box">
 
-    <a href="main.js.html">main.js</a> <a href="main.js.html#line447">line 447</a>
+    <a href="main.js.html">main.js</a> <a href="main.js.html#line466">line 466</a>
 
   </div>
 </section>
@@ -1689,7 +1689,7 @@ <h4 class="name"><span class="type-signature">(static) </span>clear<span class="
 <section class="code-source">
   <div class="link-box">
 
-    <a href="main.js.html">main.js</a> <a href="main.js.html#line467">line 467</a>
+    <a href="main.js.html">main.js</a> <a href="main.js.html#line486">line 486</a>
 
   </div>
 </section>
@@ -1808,7 +1808,7 @@ <h5>Returns:</h5>
 <section class="code-source">
   <div class="link-box">
 
-    <a href="main.js.html">main.js</a> <a href="main.js.html#line311">line 311</a>
+    <a href="main.js.html">main.js</a> <a href="main.js.html#line323">line 323</a>
 
   </div>
 </section>
@@ -1959,7 +1959,7 @@ <h5>Returns:</h5>
 <section class="code-source">
   <div class="link-box">
 
-    <a href="main.js.html">main.js</a> <a href="main.js.html#line328">line 328</a>
+    <a href="main.js.html">main.js</a> <a href="main.js.html#line340">line 340</a>
 
   </div>
 </section>
@@ -2137,7 +2137,7 @@ <h5>Throws:</h5>
 <section class="code-source">
   <div class="link-box">
 
-    <a href="main.js.html">main.js</a> <a href="main.js.html#line345">line 345</a>
+    <a href="main.js.html">main.js</a> <a href="main.js.html#line357">line 357</a>
 
   </div>
 </section>
@@ -2321,7 +2321,7 @@ <h5>Throws:</h5>
 <section class="code-source">
   <div class="link-box">
 
-    <a href="main.js.html">main.js</a> <a href="main.js.html#line409">line 409</a>
+    <a href="main.js.html">main.js</a> <a href="main.js.html#line428">line 428</a>
 
   </div>
 </section>
@@ -2800,7 +2800,7 @@ <h5>Parameters:</h5>
 
 
 <footer class="main-footer">
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu May 18 2017 14:01:26 GMT+0000 (UTC)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jun 09 2017 15:54:07 GMT+0000 (UTC)
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/doc/index.html b/doc/index.html
@@ -195,7 +195,7 @@ <h2>License</h2><p>Apache 2.0</p></article>
 
 
 <footer class="main-footer">
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu May 18 2017 14:01:26 GMT+0000 (UTC)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jun 09 2017 15:54:07 GMT+0000 (UTC)
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/doc/main.js.html b/doc/main.js.html
@@ -130,14 +130,26 @@ <h1 class="page-title">main.js</h1>
 
     if (typeof options !== 'object') {
       throw new Error(
-        'The options need to be given inside an object like this:\nnew Holmes({\n\tfind:".result"\n});\nsee also https://haroen.me/holmes/doc/holmes.html'
+        `The options need to be given inside an object like this:
+
+new Holmes({
+  find:".result"
+});
+
+see also https://haroen.me/holmes/doc/holmes.html`
       );
     }
 
     // if this.options.find is missing, the searching won't work so we'll thrown an exceptions
     if (typeof options.find !== 'string') {
       throw new Error(
-        'A find argument is needed. That should be a querySelectorAll for each of the items you want to match individually. You should have something like: \nnew Holmes({\n\tfind:".result"\n});\nsee also https://haroen.me/holmes/doc/holmes.html'
+        `A find argument is needed. That should be a querySelectorAll for each of the items you want to match individually. You should have something like:
+
+new Holmes({
+  find:".result"
+});
+
+see also https://haroen.me/holmes/doc/holmes.html`
       );
     }
 
@@ -260,7 +272,9 @@ <h1 class="page-title">main.js</h1>
       this.elementsArray.forEach((element: HTMLElement) => {
         // if the current element doesn't contain the search string
         // add the hidden class and remove the visbible class
-        if (stringIncludes(element.textContent.toLowerCase(), this.searchString)) {
+        if (
+          stringIncludes(element.textContent.toLowerCase(), this.searchString)
+        ) {
           this._showElement(element);
 
           if (empty &amp;&amp; typeof this.options.onFound === 'function') {
@@ -412,14 +426,20 @@ <h1 class="page-title">main.js</h1>
     if (_input instanceof HTMLElement) {
       this.input = _input;
     } else {
-      throw new Error('Your Holmes.input didn\'t match a querySelector');
+      throw new Error(`Your Holmes.input didn't match a querySelector`);
     }
 
     if (typeof this.options.find === 'string') {
       this.elements = document.querySelectorAll(this.options.find);
     } else {
       throw new Error(
-        'A find argument is needed. That should be a querySelectorAll for each of the items you want to match individually. You should have something like:\nnew Holmes({\n\tfind:".result"\n});\nsee also https://haroen.me/holmes/doc/holmes.html'
+        `A find argument is needed. That should be a querySelectorAll for each of the items you want to match individually. You should have something like:
+
+new Holmes({
+  find:".result"
+});
+
+see also https://haroen.me/holmes/doc/holmes.html`
       );
     }
 
@@ -441,16 +461,17 @@ <h1 class="page-title">main.js</h1>
     this.hidden = 0;
 
     // create a container for a placeholder if needed
-    if (this.options.placeholder) {
+    if (typeof this.options.placeholder === 'string') {
+      const holder: string = this.options.placeholder;
       this.placeholderNode = document.createElement('div');
       this.placeholderNode.id = 'holmes-placeholder';
       this._hideElement(this.placeholderNode);
-      this.placeholderNode.innerHTML = this.options.placeholder;
+      this.placeholderNode.innerHTML = holder;
       if (this.elements[0].parentNode instanceof Element) {
         this.elements[0].parentNode.appendChild(this.placeholderNode);
       } else {
         throw new Error(
-          'The Holmes placeholder could\'t be put; the elements had no parent.'
+          `The Holmes placeholder couldn't be put; the elements had no parent.`
         );
       }
     }
@@ -531,7 +552,7 @@ <h1 class="page-title">main.js</h1>
    * @return {object} all matching elements, the amount of hidden and the amount of visible elements
    * @memberOf holmes
    */
-  count(): { all: number, hidden: number, visible: number } {
+  count(): {all: number, hidden: number, visible: number} {
     return {
       all: this.elementsLength,
       hidden: this.hidden,
@@ -556,7 +577,7 @@ <h1 class="page-title">main.js</h1>
 
 
 <footer class="main-footer">
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu May 18 2017 14:01:26 GMT+0000 (UTC)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jun 09 2017 15:54:07 GMT+0000 (UTC)
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/doc/styles/_prettify.scss b/doc/styles/_prettify.scss
@@ -1,6 +1,6 @@
 .prettyprint {
   background: #fff;
-  font-family: $monospace;
+  font-family: Menlo, "Bitstream Vera Sans Mono", "DejaVu Sans Mono", Monaco, Consolas, monospace;
 
   &.linenums {
     padding: 0;
@@ -136,4 +136,4 @@ ol.linenums {
   }
 }
 
-/*# sourceMappingURL=_prettify-tomorrow.css.map */
+/*# sourceMappingURL=_prettify-tomorrow.css.map */
diff --git a/doc/styles/_tag.scss b/doc/styles/_tag.scss
@@ -32,6 +32,7 @@
     padding: $padding-y $padding-x;
     border-radius: inherit;
     color: currentColor;
+    width: calc(100% + #{$padding-x * 2});
     overflow: hidden;
     text-overflow: ellipsis;
     white-space: nowrap;
@@ -58,4 +59,4 @@
       color: mix(black, $color, 40%);
     }
   }
-}
+}