Replace documentation with jsdoc and use mocha-docdash pretty layout

mochajs · May 17, 2018 · b92c2c7 · b92c2c7
1 parent d768d6a
commit b92c2c7
Show file tree

Hide file tree

Showing 4 changed files with 1,764 additions and 5,661 deletions.
diff --git a/jsdoc.conf.json b/jsdoc.conf.json
@@ -0,0 +1,35 @@
+{
+    "tags": {
+        "allowUnknownTags": true
+    },
+    "source": {
+        "include": [
+            "lib/",
+            "./README.md"
+        ]
+    },
+    "plugins": ["plugins/markdown"],
+    "opts": {
+        "encoding": "utf8",
+        "template": "node_modules/mocha-docdash",
+        "destination": "docs/api",
+        "recurse": true,
+        "verbose": true
+    },
+    "markdown": {
+        "parser": "gfm",
+        "hardwrap": true
+    },
+    "templates": {
+        "cleverLinks": false,
+        "monospaceLinks": false,
+        "default": {
+            "outputSourceFiles": true,
+            "includeDate": false
+        }
+    },
+    "mocha-docdash": {
+        "static": false,
+        "sort": true
+    }
+}