Merge pull request #682 from EOSIO/docs/21.0.0

adjustments to 21.0.0 docs

Author: dskvr

docs.json

@@ -10,37 +10,11 @@
 		{
 			"name": "typedoc",
 			"options": {
-        "theme": "markdown",
-        "exclude": ["**/index*","**/*.test.ts","**/rpc-web*"],
-        "ignoreCompilerErrors": true,
-        "includeDeclarations": false,
-        "excludeExternals": true,
-        "excludeProtected": true,
-        "excludePrivate": true,
-        "typescript": {
-          "include": [
-            "src/**/*.js"
-          ]
-        }
-      }
+				"disable_filters": true
+			},
+			"filters": [
+				{ "name":  "remove_extension" }
+			]
 		}
-	],
-  "filters": [
-    {
-      "name": "search_replace",
-      "options": {
-        "search": "numeric.md#",
-        "replace": "#",
-        "filepattern": "numeric.md"
-      }
-    },
-    {
-      "name": "search_replace",
-      "options": {
-        "search": "serialize.md#",
-        "replace": "#",
-        "filepattern": "serialize.md"
-      }
-    }
-  ]
+	]
 }

docs/00_introduction.md renamed to docs/index.md

@@ -1,3 +1,7 @@
+---
+content_title: eosjs
+---
+
 `eosjs` is a Javascript library which provides an API for integrating with EOSIO-based blockchains using the [EOSIO Nodeos RPC API](https://developers.eos.io/eosio-nodeos/reference).  The documentation for `eosjs` is structured in the following way:
 
 * [Installation](02_installation.md) explains how to install `eosjs` using `npm` or `yarn`.

package.json

@@ -16,10 +16,7 @@
     "build-web": "webpack --config webpack.prod.js && webpack --config webpack.debug.js",
     "build-production": "yarn build && yarn build-web && yarn test-all",
     "clean": "rm -rf dist",
-    "docs-init": "sh .docs/scripts/init.sh",
-    "docs-build": "sh .docs/scripts/build.sh",
-    "docs-serve": "python -m SimpleHTTPServer",
-    "docs-publish": "sh .docs/scripts/publish.sh"
+    "docs": "yarn typedoc"
   },
   "author": "block.one",
   "license": "MIT",
@@ -53,7 +50,9 @@
     "tslint-eslint-rules": "5.4.0",
     "typescript": "3.3.3",
     "webpack": "4.41.5",
-    "webpack-cli": "3.2.3"
+    "webpack-cli": "3.2.3",
+    "typedoc": "^0.16.9",
+    "typedoc-plugin-external-module-name": "^3.0.0"
   },
   "jest": {
     "automock": false,

typedoc.json

@@ -1,19 +1,18 @@
 {
-  "name": "eosjs",
-  "target": "es5",
-  "module": ["es2017","dom"],
+  "tsconfig": "tsconfig.json",
   "ignoreCompilerErrors": true,
+  "hideGenerator": true,
   "includeDeclarations": false,
-  "excludeProtected": true,
+  "excludeExternals": true,
   "excludePrivate": true,
+  "excludeProtected": true,
+  "externalPattern": "**/node_modules/**",
+  "excludeNotExported": true,
+  "exclude": ["**/index*","**/*.test.ts","**/*.test.js", "**/node_modules/**"],
   "mode": "modules",
-  "out": "docs-build",
-  "theme": "markdown",
-  "mdEngine": "gitbook",
-  "stripExternal": false,
-  "exclude": ["**/index*","**/*.test.ts"],
   "readme": "README.md",
-  "hideGenerator": "true",
-  "verbose": true,
-  "mdSourceRepo": "https://www.github.com/EOSIO/eosjs"
+  "module": "commonjs",
+  "theme": "minimal",
+  "target": "ES5",
+  "out": "./reference"
 }