Update website to Docusaurus v3

ceramicnetwork · Jul 4, 2024 · b7d1d30 · b7d1d30
1 parent 9e92e7e
commit b7d1d30
Show file tree

Hide file tree

Showing 73 changed files with 7,513 additions and 5,928 deletions.
diff --git a/package.json b/package.json
@@ -28,8 +28,8 @@
     "jest": "^29.7.0",
     "prettier": "^3.1.1",
     "turbo": "^1.11.2",
-    "typedoc": "0.25.4",
-    "typedoc-plugin-markdown": "^3.17.1",
-    "typescript": "^5.3.3"
+    "typedoc": "0.26.3",
+    "typedoc-plugin-markdown": "^4.1.1",
+    "typescript": "^5.5.3"
   }
 }
diff --git a/packages/dids/src/index.ts b/packages/dids/src/index.ts
@@ -1,6 +1,4 @@
 /**
- * # DID
- *
  * A simple library to interact with DIDs that conform to the DID-provider interface.
  *
  * ## Installation

diff --git a/packages/key-did-provider-ed25519/src/index.ts b/packages/key-did-provider-ed25519/src/index.ts
@@ -1,5 +1,4 @@
 /**
- * # ed25519 key did provider
  * This is a DID Provider which implements [EIP2844](https://eips.ethereum.org/EIPS/eip-2844) for `did:key:` using ed25519. It also supports decryption using x25519.
  *
  * ## Installation

diff --git a/packages/key-did-provider-secp256k1/src/index.ts b/packages/key-did-provider-secp256k1/src/index.ts
@@ -1,5 +1,4 @@
 /**
- * # secp256k1 Key Did Provider
  * This is a DID Provider which implements [EIP2844](https://eips.ethereum.org/EIPS/eip-2844) for `did:key:` using secp256k1.
  *
  * ## Installation
@@ -30,7 +29,7 @@
  * await did.verifyJWS(jws)
  * ```
  *
- * @module @didtools/key-secp256k1
+ * @module key-secp256k1
  */
 
 import { createJWS, ES256KSigner } from 'did-jwt'

diff --git a/packages/key-did-provider-webcrypto/src/index.ts b/packages/key-did-provider-webcrypto/src/index.ts
@@ -1,5 +1,4 @@
 /**
- * # Webcrypto Key Did Provider
  * This is a DID Provider which implements [EIP2844](https://eips.ethereum.org/EIPS/eip-2844) for `did:key:` using webcrypto with non-extractable keys.
  *
  * ## Installation
@@ -30,7 +29,7 @@
  * await did.verifyJWS(jws)
  * ```
  *
- * @module @didtools/key-webcrypto
+ * @module key-webcrypto
  */
 
 import type {

diff --git a/packages/key-did/src/index.ts b/packages/key-did/src/index.ts
@@ -1,6 +1,4 @@
 /**
- * # Key DID
- *
  * Utility functions for `did:key` DIDs.
  *
  * ## Installation

diff --git a/packages/key-webauthn/package.json b/packages/key-webauthn/package.json
@@ -54,7 +54,7 @@
     "did-session": "workspace:*",
     "dids": "workspace:*",
     "esbuild": "^0.19.9",
-    "typescript": "^5.3.2"
+    "typescript": "^5.5.3"
   },
   "dependencies": {
     "@didtools/cacao": "workspace:*",

diff --git a/packages/multidid/src/index.ts b/packages/multidid/src/index.ts
@@ -1,5 +1,4 @@
 /**
- * # Multidid
  * Multidid is a representation strategy for DIDs and DID URLs that is very compact and extensible. It allows any DID method to be represented as a
  * string of bytes. Reference [specification](https://github.com/ChainAgnostic/multidid).
  *
@@ -40,7 +39,7 @@
  *
  * ```
  *
- * @module @didtools/multidid
+ * @module multidid
  */
 
 import * as u8a from 'uint8arrays'

diff --git a/packages/pkh-did-resolver/src/index.ts b/packages/pkh-did-resolver/src/index.ts
@@ -1,6 +1,4 @@
 /**
- * # PKH DID method resolver
- *
  * This package contains did:pkh method resolver implementation. Please refer to the [specification](https://github.com/w3c-ccg/did-pkh/blob/main/did-pkh-method-draft.md) for details about how this DID method works.
  *
  * ## Usage

diff --git a/packages/pkh-ethereum/package.json b/packages/pkh-ethereum/package.json
@@ -44,7 +44,7 @@
   },
   "homepage": "https://github.com/ceramicnetwork/js-did#readme",
   "devDependencies": {
-    "typescript": "^5.3.2"
+    "typescript": "^5.5.3"
   },
   "dependencies": {
     "@didtools/cacao": "workspace:^3.0.0",

diff --git a/packages/pkh-ethereum/src/index.ts b/packages/pkh-ethereum/src/index.ts
@@ -1,5 +1,4 @@
 /**
- * # Ethereum AuthMethod and Verifier
  * Implements support to authenticate, authorize and verify with Ethereum accounts as a did:pkh with SIWE(X) and CACAO.
  * Primarly used with `did-session` and `@didtools/cacao`.
  *

diff --git a/packages/pkh-solana/package.json b/packages/pkh-solana/package.json
@@ -44,7 +44,7 @@
   },
   "homepage": "https://github.com/ceramicnetwork/js-did#readme",
   "devDependencies": {
-    "typescript": "^5.3.2"
+    "typescript": "^5.5.3"
   },
   "dependencies": {
     "@didtools/cacao": "workspace:^3.0.0",

diff --git a/packages/pkh-solana/src/index.ts b/packages/pkh-solana/src/index.ts
@@ -1,5 +1,4 @@
 /**
- * # Solana AuthMethod and Verifier
  * Implements support to authenticate, authorize and verify with Solana accounts as a did:pkh with SIWS(X) and CACAO.
  * Primarly used with `did-session` and `@didtools/cacao`.
  *

diff --git a/packages/pkh-stacks/package.json b/packages/pkh-stacks/package.json
@@ -43,7 +43,7 @@
   },
   "homepage": "https://github.com/ceramicnetwork/js-did#readme",
   "devDependencies": {
-    "typescript": "^5.3.2"
+    "typescript": "^5.5.3"
   },
   "dependencies": {
     "@didtools/cacao": "workspace:^3.0.0",

diff --git a/packages/pkh-tezos/package.json b/packages/pkh-tezos/package.json
@@ -46,7 +46,7 @@
     "@taquito/signer": "^17.4.0",
     "@taquito/taquito": "^17.4.0",
     "@taquito/utils": "^17.4.0",
-    "typescript": "^5.3.2"
+    "typescript": "^5.5.3"
   },
   "dependencies": {
     "@didtools/cacao": "workspace:^3.0.0",

diff --git a/packages/siwx/src/index.ts b/packages/siwx/src/index.ts
@@ -1,3 +1,7 @@
+/**
+ * @module siwx
+ */
+
 export {
   SiwxMessage,
   toString,