👷 chore: Update docs to use typedoc.json only (#547)

## Description Update docs to only use typedoc.json ## Testing Explain the quality checks that have been done on the code changes ## Additional Information - [ ] I read the [contributing docs](../docs/contributing.md) (if this is your first contribution) Your ENS/address: Co-authored-by: Will Cory <[email protected]>
evmts · Oct 14, 2023 · df933a9 · df933a9 · vercel · Oct 14, 2023
1 parent eea5ae9
commit df933a9
Show file tree

Hide file tree

Showing 9 changed files with 67 additions and 22 deletions.
diff --git a/blockexplorer/package.json b/blockexplorer/package.json
@@ -44,7 +44,7 @@
 		"clean": "rm -rf node_modules && rm -rf artifacts && rm -rf dist && rm -rf cache",
 		"format": "rome format . --write",
 		"format:check": "rome format .",
-		"generate:docs": "typedoc --plugin typedoc-plugin-markdown --out ../docs/reference/blockexplorer --publicPath /reference/blockexplorer/ src/index.d.ts",
+		"generate:docs": "typedoc",
 		"lint": "rome check . --apply-unsafe",
 		"lint:check": "rome check . --verbose",
 		"package:up": "pnpm up --latest",

diff --git a/blockexplorer/typedoc.json b/blockexplorer/typedoc.json
@@ -0,0 +1,12 @@
+{
+	"$schema": "https://typedoc.org/schema.json",
+	"out": "../docs/reference/blockexplorer",
+	"entryPoints": [
+		"./src/index.js"
+	],
+  "publicPath": "/reference/blockexplorer/",
+	"plugin": [
+		"typedoc-plugin-markdown"
+	],
+	"gitRevision": "main"
+}
diff --git a/bundlers/bundler/typedoc.json b/bundlers/bundler/typedoc.json
@@ -9,5 +9,9 @@
 		"./src/solc/index.ts",
 		"./src/utils/index.ts"
 	],
+  "publicPath": "/reference/bundler/",
+	"plugin": [
+		"typedoc-plugin-markdown"
+	],
 	"gitRevision": "main"
 }
diff --git a/docs/reference/blockexplorer/classes/SafeStandardBlockExplorer.md b/docs/reference/blockexplorer/classes/SafeStandardBlockExplorer.md
@@ -51,7 +51,7 @@ const txUrlEffect = etherscan.getTxUrl('0x1234')
 
 #### Defined in
 
-[blockExplorer.js:60](https://github.com/evmts/evmts-monorepo/blob/d00ace50/blockexplorer/src/blockExplorer.js#L60)
+[blockExplorer.js:60](https://github.com/evmts/evmts-monorepo/blob/main/blockexplorer/src/blockExplorer.js#L60)
 
 ## Properties
 
@@ -61,7 +61,7 @@ const txUrlEffect = etherscan.getTxUrl('0x1234')
 
 #### Defined in
 
-[blockExplorer.js:63](https://github.com/evmts/evmts-monorepo/blob/d00ace50/blockexplorer/src/blockExplorer.js#L63)
+[blockExplorer.js:63](https://github.com/evmts/evmts-monorepo/blob/main/blockexplorer/src/blockExplorer.js#L63)
 
 ___
 
@@ -71,7 +71,7 @@ ___
 
 #### Defined in
 
-[blockExplorer.js:61](https://github.com/evmts/evmts-monorepo/blob/d00ace50/blockexplorer/src/blockExplorer.js#L61)
+[blockExplorer.js:61](https://github.com/evmts/evmts-monorepo/blob/main/blockexplorer/src/blockExplorer.js#L61)
 
 ___
 
@@ -81,7 +81,7 @@ ___
 
 #### Defined in
 
-[blockExplorer.js:62](https://github.com/evmts/evmts-monorepo/blob/d00ace50/blockexplorer/src/blockExplorer.js#L62)
+[blockExplorer.js:62](https://github.com/evmts/evmts-monorepo/blob/main/blockexplorer/src/blockExplorer.js#L62)
 
 ___
 
@@ -95,7 +95,7 @@ Can be used to handle errors in a typesafe way
 
 #### Defined in
 
-[blockExplorer.js:50](https://github.com/evmts/evmts-monorepo/blob/d00ace50/blockexplorer/src/blockExplorer.js#L50)
+[blockExplorer.js:50](https://github.com/evmts/evmts-monorepo/blob/main/blockexplorer/src/blockExplorer.js#L50)
 
 ## Methods
 
@@ -130,7 +130,7 @@ const addressUrl = etherscan.getAddressUrl('0x1234')
 
 #### Defined in
 
-[blockExplorer.js:129](https://github.com/evmts/evmts-monorepo/blob/d00ace50/blockexplorer/src/blockExplorer.js#L129)
+[blockExplorer.js:129](https://github.com/evmts/evmts-monorepo/blob/main/blockexplorer/src/blockExplorer.js#L129)
 
 ___
 
@@ -165,7 +165,7 @@ const blockUrl = etherscan.getBlockUrl('0x1234')
 
 #### Defined in
 
-[blockExplorer.js:104](https://github.com/evmts/evmts-monorepo/blob/d00ace50/blockexplorer/src/blockExplorer.js#L104)
+[blockExplorer.js:104](https://github.com/evmts/evmts-monorepo/blob/main/blockexplorer/src/blockExplorer.js#L104)
 
 ___
 
@@ -200,4 +200,4 @@ const etherscan = new StandardBlockExplorer(
 
 #### Defined in
 
-[blockExplorer.js:80](https://github.com/evmts/evmts-monorepo/blob/d00ace50/blockexplorer/src/blockExplorer.js#L80)
+[blockExplorer.js:80](https://github.com/evmts/evmts-monorepo/blob/main/blockexplorer/src/blockExplorer.js#L80)
diff --git a/docs/reference/blockexplorer/classes/StandardBlockExplorer.md b/docs/reference/blockexplorer/classes/StandardBlockExplorer.md
@@ -51,7 +51,7 @@ const txUrl = etherscan.getTxUrl('0x1234')
 
 #### Defined in
 
-[blockExplorer.js:190](https://github.com/evmts/evmts-monorepo/blob/d00ace50/blockexplorer/src/blockExplorer.js#L190)
+[blockExplorer.js:190](https://github.com/evmts/evmts-monorepo/blob/main/blockexplorer/src/blockExplorer.js#L190)
 
 ## Properties
 
@@ -61,7 +61,7 @@ const txUrl = etherscan.getTxUrl('0x1234')
 
 #### Defined in
 
-[blockExplorer.js:193](https://github.com/evmts/evmts-monorepo/blob/d00ace50/blockexplorer/src/blockExplorer.js#L193)
+[blockExplorer.js:193](https://github.com/evmts/evmts-monorepo/blob/main/blockexplorer/src/blockExplorer.js#L193)
 
 ___
 
@@ -71,7 +71,7 @@ ___
 
 #### Defined in
 
-[blockExplorer.js:191](https://github.com/evmts/evmts-monorepo/blob/d00ace50/blockexplorer/src/blockExplorer.js#L191)
+[blockExplorer.js:191](https://github.com/evmts/evmts-monorepo/blob/main/blockexplorer/src/blockExplorer.js#L191)
 
 ___
 
@@ -81,7 +81,7 @@ ___
 
 #### Defined in
 
-[blockExplorer.js:194](https://github.com/evmts/evmts-monorepo/blob/d00ace50/blockexplorer/src/blockExplorer.js#L194)
+[blockExplorer.js:194](https://github.com/evmts/evmts-monorepo/blob/main/blockexplorer/src/blockExplorer.js#L194)
 
 ___
 
@@ -91,7 +91,7 @@ ___
 
 #### Defined in
 
-[blockExplorer.js:192](https://github.com/evmts/evmts-monorepo/blob/d00ace50/blockexplorer/src/blockExplorer.js#L192)
+[blockExplorer.js:192](https://github.com/evmts/evmts-monorepo/blob/main/blockexplorer/src/blockExplorer.js#L192)
 
 ___
 
@@ -121,7 +121,7 @@ try {
 
 #### Defined in
 
-[blockExplorer.js:180](https://github.com/evmts/evmts-monorepo/blob/d00ace50/blockexplorer/src/blockExplorer.js#L180)
+[blockExplorer.js:180](https://github.com/evmts/evmts-monorepo/blob/main/blockexplorer/src/blockExplorer.js#L180)
 
 ## Methods
 
@@ -156,7 +156,7 @@ const etherscan = new StandardBlockExplorer(
 
 #### Defined in
 
-[blockExplorer.js:247](https://github.com/evmts/evmts-monorepo/blob/d00ace50/blockexplorer/src/blockExplorer.js#L247)
+[blockExplorer.js:247](https://github.com/evmts/evmts-monorepo/blob/main/blockexplorer/src/blockExplorer.js#L247)
 
 ___
 
@@ -191,7 +191,7 @@ const blockUrl = etherscan.getBlockUrl('0x1234')
 
 #### Defined in
 
-[blockExplorer.js:229](https://github.com/evmts/evmts-monorepo/blob/d00ace50/blockexplorer/src/blockExplorer.js#L229)
+[blockExplorer.js:229](https://github.com/evmts/evmts-monorepo/blob/main/blockexplorer/src/blockExplorer.js#L229)
 
 ___
 
@@ -226,4 +226,4 @@ const txUrl = etherscan.getTxUrl('0x1234')
 
 #### Defined in
 
-[blockExplorer.js:211](https://github.com/evmts/evmts-monorepo/blob/d00ace50/blockexplorer/src/blockExplorer.js#L211)
+[blockExplorer.js:211](https://github.com/evmts/evmts-monorepo/blob/main/blockexplorer/src/blockExplorer.js#L211)
diff --git a/docs/reference/blockexplorer/interfaces/BlockExplorerOptions.md b/docs/reference/blockexplorer/interfaces/BlockExplorerOptions.md
@@ -18,7 +18,7 @@
 
 #### Defined in
 
-[blockExplorer.js:21](https://github.com/evmts/evmts-monorepo/blob/d00ace50/blockexplorer/src/blockExplorer.js#L21)
+[blockExplorer.js:21](https://github.com/evmts/evmts-monorepo/blob/main/blockexplorer/src/blockExplorer.js#L21)
 
 ___
 
@@ -28,7 +28,7 @@ ___
 
 #### Defined in
 
-[blockExplorer.js:19](https://github.com/evmts/evmts-monorepo/blob/d00ace50/blockexplorer/src/blockExplorer.js#L19)
+[blockExplorer.js:19](https://github.com/evmts/evmts-monorepo/blob/main/blockexplorer/src/blockExplorer.js#L19)
 
 ___
 
@@ -38,4 +38,4 @@ ___
 
 #### Defined in
 
-[blockExplorer.js:20](https://github.com/evmts/evmts-monorepo/blob/d00ace50/blockexplorer/src/blockExplorer.js#L20)
+[blockExplorer.js:20](https://github.com/evmts/evmts-monorepo/blob/main/blockexplorer/src/blockExplorer.js#L20)
diff --git a/docs/reference/blockexplorer/modules.md b/docs/reference/blockexplorer/modules.md
@@ -12,3 +12,28 @@
 ### Interfaces
 
 - [BlockExplorerOptions](/reference/blockexplorer/interfaces/BlockExplorerOptions.md)
+
+### Type Aliases
+
+- [Address](/reference/blockexplorer/modules.md#address)
+- [Hex](/reference/blockexplorer/modules.md#hex)
+
+## Type Aliases
+
+### Address
+
+Ƭ **Address**<\>: \`0x${string}\`
+
+#### Defined in
+
+[blockExplorer.js:14](https://github.com/evmts/evmts-monorepo/blob/main/blockexplorer/src/blockExplorer.js#L14)
+
+___
+
+### Hex
+
+Ƭ **Hex**<\>: \`0x${string}\`
+
+#### Defined in
+
+[blockExplorer.js:13](https://github.com/evmts/evmts-monorepo/blob/main/blockexplorer/src/blockExplorer.js#L13)
diff --git a/schemas/package.json b/schemas/package.json
@@ -46,7 +46,7 @@
 		"clean": "rm -rf node_modules && rm -rf artifacts && rm -rf dist && rm -rf cache",
 		"format": "rome format . --write",
 		"format:check": "rome format .",
-		"generate:docs": "typedoc --plugin typedoc-plugin-markdown --publicPath /reference/schemas/",
+		"generate:docs": "typedoc",
 		"lint": "rome check . --apply-unsafe",
 		"lint:check": "rome check . --verbose",
 		"package:up": "pnpm up --latest",

diff --git a/schemas/typedoc.json b/schemas/typedoc.json
@@ -7,5 +7,9 @@
 		"./src/common/index.js",
 		"./src/evmts/index.js"
 	],
+	"publicPath": "/reference/schemas/",
+	"plugin": [
+		"typedoc-plugin-markdown"
+	],
 	"gitRevision": "main"
 }