From 64d98596f94dd27cb7f164dab62601b2ffcbdc4f Mon Sep 17 00:00:00 2001 From: Daniel Kantor Date: Wed, 31 Jan 2018 20:52:01 +0000 Subject: [PATCH] feat(docs): added README.md to docs (#26) --- docs/components_chart_Chart.js.html | 2 +- docs/components_columns_Columns.js.html | 2 +- docs/components_root_Root.js.html | 2 +- docs/components_rows_Rows.js.html | 2 +- docs/components_text_Text.js.html | 2 +- docs/global.html | 2 +- docs/index.html | 32 ++++++++++++++++++++++++- docs/module-components_chart.html | 2 +- docs/module-components_columns.html | 2 +- docs/module-components_root.html | 2 +- docs/module-components_rows.html | 2 +- docs/module-components_text.html | 2 +- docs/parser_parser.js.html | 2 +- docs/yaml-format_parser.js.html | 2 +- package-lock.json | 6 +++++ package.json | 3 ++- 16 files changed, 52 insertions(+), 15 deletions(-) diff --git a/docs/components_chart_Chart.js.html b/docs/components_chart_Chart.js.html index 8ddb62d2..4658a672 100644 --- a/docs/components_chart_Chart.js.html +++ b/docs/components_chart_Chart.js.html @@ -95,7 +95,7 @@

components/chart/Chart.js


diff --git a/docs/components_columns_Columns.js.html b/docs/components_columns_Columns.js.html index ac2e366f..c63b7cb3 100644 --- a/docs/components_columns_Columns.js.html +++ b/docs/components_columns_Columns.js.html @@ -105,7 +105,7 @@

components/columns/Columns.js


diff --git a/docs/components_root_Root.js.html b/docs/components_root_Root.js.html index bd8a2cd0..3e0991a4 100644 --- a/docs/components_root_Root.js.html +++ b/docs/components_root_Root.js.html @@ -91,7 +91,7 @@

components/root/Root.js


diff --git a/docs/components_rows_Rows.js.html b/docs/components_rows_Rows.js.html index 074de6c7..ece1e08d 100644 --- a/docs/components_rows_Rows.js.html +++ b/docs/components_rows_Rows.js.html @@ -86,7 +86,7 @@

components/rows/Rows.js


diff --git a/docs/components_text_Text.js.html b/docs/components_text_Text.js.html index 59e4704d..51125642 100644 --- a/docs/components_text_Text.js.html +++ b/docs/components_text_Text.js.html @@ -98,7 +98,7 @@

components/text/Text.js


diff --git a/docs/global.html b/docs/global.html index 3ae81973..bc225dc0 100644 --- a/docs/global.html +++ b/docs/global.html @@ -420,7 +420,7 @@
Returns:

diff --git a/docs/index.html b/docs/index.html index aa7824f9..f4b2149c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -47,6 +47,36 @@ +
+

dashboard Travis Codecov

Turn this:

+
dashboard "Food":
+  - h1 text: Food
+  - h2 text: By caloric content
+  - 3 columns:
+    - rows:
+      - h3 text: Bananas
+      - pie chart: {
+          "columns": [
+            ["Protein", 5], ["Sugar", 10], ["Other carbs", 40], ["Fat", 1]
+          ]
+        }
+    - rows:
+      - h3 text: Tofu
+      - pie chart: {
+          "columns": [
+            ["Protein", 30], ["Sugar", 0], ["Other carbs", 40], ["Fat", 3]
+          ]
+        }
+    - rows:
+      - h3 text: Peanut butter
+      - pie chart: {
+          "columns": [
+            ["Protein", 20], ["Sugar", 2], ["Other carbs", 20], ["Fat", 50]
+          ]
+}

Into this: +http://bottoml.in/e/kantord/2973bdd4ad689642562018bb4091ffbd

+
+ @@ -57,7 +87,7 @@
diff --git a/docs/module-components_chart.html b/docs/module-components_chart.html index 60449f7d..f9c56cb7 100644 --- a/docs/module-components_chart.html +++ b/docs/module-components_chart.html @@ -301,7 +301,7 @@
Examples

diff --git a/docs/module-components_columns.html b/docs/module-components_columns.html index 966ed6c8..874ca9fe 100644 --- a/docs/module-components_columns.html +++ b/docs/module-components_columns.html @@ -332,7 +332,7 @@
Examples

diff --git a/docs/module-components_root.html b/docs/module-components_root.html index c0fd73e2..69425b91 100644 --- a/docs/module-components_root.html +++ b/docs/module-components_root.html @@ -298,7 +298,7 @@
Examples

diff --git a/docs/module-components_rows.html b/docs/module-components_rows.html index 07011631..76b5ff9e 100644 --- a/docs/module-components_rows.html +++ b/docs/module-components_rows.html @@ -298,7 +298,7 @@
Examples

diff --git a/docs/module-components_text.html b/docs/module-components_text.html index 98773bca..df3b82bd 100644 --- a/docs/module-components_text.html +++ b/docs/module-components_text.html @@ -301,7 +301,7 @@
Examples

diff --git a/docs/parser_parser.js.html b/docs/parser_parser.js.html index b270ecc7..be56ba81 100644 --- a/docs/parser_parser.js.html +++ b/docs/parser_parser.js.html @@ -72,7 +72,7 @@

parser/parser.js


diff --git a/docs/yaml-format_parser.js.html b/docs/yaml-format_parser.js.html index 856cab59..2d0e067e 100644 --- a/docs/yaml-format_parser.js.html +++ b/docs/yaml-format_parser.js.html @@ -139,7 +139,7 @@

yaml-format/parser.js


diff --git a/package-lock.json b/package-lock.json index 2dc9645b..13701948 100644 --- a/package-lock.json +++ b/package-lock.json @@ -7488,6 +7488,12 @@ "integrity": "sha1-5md4PZLonb00KBi1IwudYqZyrRg=", "dev": true }, + "minami": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/minami/-/minami-1.2.3.tgz", + "integrity": "sha1-mbbc37LwpU2hycj3qjoyd4eq+fg=", + "dev": true + }, "minimalistic-assert": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/minimalistic-assert/-/minimalistic-assert-1.0.0.tgz", diff --git a/package.json b/package.json index c8ad5818..94860592 100644 --- 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",