use custom docs/API.md instead of broken README.md

Signed-off-by: Christopher Hiller <boneskull@boneskull.com>
mochajs · Apr 21, 2018 · efff26f · efff26f
1 parent 7f8fa42
commit efff26f
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 31 deletions.
diff --git a/docs/API.md b/docs/API.md
@@ -0,0 +1,20 @@
+# Mocha's API Documentation
+
+* * *
+
+Congratulations!  You've found Mocha's API documentation.  These docs are for developers who wish to:
+
+- Create an extension for Mocha, or
+- Develop Mocha itself, or
+- Do something else fancy with Mocha
+
+Otherwise, **you probably want the [main documentation](https://mochajs.org)**.
+
+## Other Links
+
+- **[Main Documentation](https://mochajs.org)**
+- **[Release Notes / History / Changes](https://github.com/mochajs/mocha/blob/master/CHANGELOG.md)**
+- [Code of Conduct](https://github.com/mochajs/mocha/blob/master/.github/CODE_OF_CONDUCT.md)
+- [Gitter Chatroom](https://gitter.im/mochajs/mocha) (ask questions here!)
+- [Google Group](https://groups.google.com/group/mochajs)
+- [Issue Tracker](https://github.com/mochajs/mocha/issues)
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -3,6 +3,7 @@ exclude:
   - README.md
   - .*
   - LICENSE*
+  - API.md
 repository: mochajs/mocha
 source: docs
 
diff --git a/jsdoc.conf.json b/jsdoc.conf.json
@@ -1,35 +1,32 @@
 {
-    "tags": {
-        "allowUnknownTags": true
-    },
-    "source": {
-        "include": [
-            "lib/",
-            "./README.md"
-        ]
-    },
-    "plugins": ["plugins/markdown"],
-    "opts": {
-        "encoding": "utf8",
+  "tags": {
+    "allowUnknownTags": true
+  },
+  "source": {
+    "include": ["lib/", "./docs/API.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
+    "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
+  }
 }