feat(docs): added README.md to docs (#26)

kantord · Jan 31, 2018 · 64d9859 · 64d9859
1 parent e30dc49
commit 64d9859
Show file tree

Hide file tree

Showing 16 changed files with 52 additions and 15 deletions.
diff --git a/docs/components_chart_Chart.js.html b/docs/components_chart_Chart.js.html
@@ -95,7 +95,7 @@ <h1 class="page-title">components/chart/Chart.js</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 19:46:51 GMT+0100 (CET) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 21:42:27 GMT+0100 (CET) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/components_columns_Columns.js.html b/docs/components_columns_Columns.js.html
@@ -105,7 +105,7 @@ <h1 class="page-title">components/columns/Columns.js</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 19:46:51 GMT+0100 (CET) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 21:42:27 GMT+0100 (CET) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/components_root_Root.js.html b/docs/components_root_Root.js.html
@@ -91,7 +91,7 @@ <h1 class="page-title">components/root/Root.js</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 19:46:51 GMT+0100 (CET) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 21:42:27 GMT+0100 (CET) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/components_rows_Rows.js.html b/docs/components_rows_Rows.js.html
@@ -86,7 +86,7 @@ <h1 class="page-title">components/rows/Rows.js</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 19:46:51 GMT+0100 (CET) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 21:42:27 GMT+0100 (CET) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/components_text_Text.js.html b/docs/components_text_Text.js.html
@@ -98,7 +98,7 @@ <h1 class="page-title">components/text/Text.js</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 19:46:51 GMT+0100 (CET) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 21:42:27 GMT+0100 (CET) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/global.html b/docs/global.html
@@ -420,7 +420,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 19:46:51 GMT+0100 (CET) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 21:42:27 GMT+0100 (CET) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/index.html b/docs/index.html
@@ -47,6 +47,36 @@
 
 
 
+    <section class="readme">
+        <article><h1>dashboard <a href=""><img src="https://img.shields.io/travis/kantord/dashboard.svg" alt="Travis"></a> <a href=""><img src="https://img.shields.io/codecov/c/github/kantord/dashboard.svg" alt="Codecov"></a></h1><p>Turn this:</p>
+<pre class="prettyprint source"><code>dashboard &quot;Food&quot;:
+  - h1 text: Food
+  - h2 text: By caloric content
+  - 3 columns:
+    - rows:
+      - h3 text: Bananas
+      - pie chart: {
+          &quot;columns&quot;: [
+            [&quot;Protein&quot;, 5], [&quot;Sugar&quot;, 10], [&quot;Other carbs&quot;, 40], [&quot;Fat&quot;, 1]
+          ]
+        }
+    - rows:
+      - h3 text: Tofu
+      - pie chart: {
+          &quot;columns&quot;: [
+            [&quot;Protein&quot;, 30], [&quot;Sugar&quot;, 0], [&quot;Other carbs&quot;, 40], [&quot;Fat&quot;, 3]
+          ]
+        }
+    - rows:
+      - h3 text: Peanut butter
+      - pie chart: {
+          &quot;columns&quot;: [
+            [&quot;Protein&quot;, 20], [&quot;Sugar&quot;, 2], [&quot;Other carbs&quot;, 20], [&quot;Fat&quot;, 50]
+          ]
+}</code></pre><p>Into this:
+http://bottoml.in/e/kantord/2973bdd4ad689642562018bb4091ffbd</p></article>
+    </section>
+
 
 
 
@@ -57,7 +87,7 @@
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 19:46:51 GMT+0100 (CET) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 21:42:27 GMT+0100 (CET) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/module-components_chart.html b/docs/module-components_chart.html
@@ -301,7 +301,7 @@ <h5>Examples</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 19:46:51 GMT+0100 (CET) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 21:42:27 GMT+0100 (CET) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/module-components_columns.html b/docs/module-components_columns.html
@@ -332,7 +332,7 @@ <h5>Examples</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 19:46:51 GMT+0100 (CET) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 21:42:27 GMT+0100 (CET) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/module-components_root.html b/docs/module-components_root.html
@@ -298,7 +298,7 @@ <h5>Examples</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 19:46:51 GMT+0100 (CET) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 21:42:27 GMT+0100 (CET) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/module-components_rows.html b/docs/module-components_rows.html
@@ -298,7 +298,7 @@ <h5>Examples</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 19:46:51 GMT+0100 (CET) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 21:42:27 GMT+0100 (CET) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/module-components_text.html b/docs/module-components_text.html
@@ -301,7 +301,7 @@ <h5>Examples</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 19:46:51 GMT+0100 (CET) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 21:42:27 GMT+0100 (CET) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/parser_parser.js.html b/docs/parser_parser.js.html
@@ -72,7 +72,7 @@ <h1 class="page-title">parser/parser.js</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 19:46:51 GMT+0100 (CET) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 21:42:27 GMT+0100 (CET) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/yaml-format_parser.js.html b/docs/yaml-format_parser.js.html
@@ -139,7 +139,7 @@ <h1 class="page-title">yaml-format/parser.js</h1>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 19:46:51 GMT+0100 (CET) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Jan 31 2018 21:42:27 GMT+0100 (CET) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -10,7 +10,7 @@
     "build": "WEBPACK_ENV=build webpack",
     "dev": "WEBPACK_ENV=dev webpack --progress --colors --watch",
     "html-coverage": "cross-env NODE_ENV=test nyc --reporter=html mocha-webpack \"src/**/*.test.js\" --webpack-config webpack.test.config.js",
-    "generate-doc": "jsdoc -c jsdoc.conf.json",
+    "generate-doc": "jsdoc -c jsdoc.conf.json --readme ./README.md",
     "lint": "eslint src",
     "lint:fix": "eslint src --fix",
     "coverage": "cross-env NODE_ENV=test nyc --reporter=lcov --reporter=text npm run test",
@@ -54,6 +54,7 @@
     "jsdoc-babel": "^0.3.0",
     "jsdom": "^11.6.2",
     "jsdom-global": "^3.0.2",
+    "minami": "^1.2.3",
     "mocha": "^5.0.0",
     "mocha-webpack": "^1.0.1",
     "node-sass": "^4.7.2",