docs(deps): upgraded docusaurus to v3 (cosmos#5507)

* deps: manual update * deps: upgraded to docusaurus v3 * imp: started fixing mdx v3 conflicts * imp: removed useless synopsis tag * imp: resolved all mdx v3 conflicts * deps: updated to docusaurus v3.0.1
likesToEatFish · Jan 3, 2024 · dc001d4 · dc001d4
1 parent 6736c09
commit dc001d4
Show file tree

Hide file tree

Showing 55 changed files with 8,563 additions and 15,762 deletions.
diff --git a/docs/architecture/adr.template.md b/docs/architecture/adr.template.md
@@ -1,14 +1,14 @@
-# ADR {ADR-NUMBER}: {TITLE}
+# ADR \{ADR-NUMBER\}: \{TITLE\}
 
 ## Changelog
 
-- {date}: {changelog}
+- \{date\}: \{changelog\}
 
 ## Status
 
 > A decision may be "proposed" if it hasn't been agreed upon yet, or "accepted" once it is agreed upon. If a later ADR changes or reverses a decision, it may be marked as "deprecated" or "superseded" with a reference to its replacement.
 
-{Deprecated|Proposed|Accepted}
+\{Deprecated|Proposed|Accepted\}
 
 ## Context
 
@@ -35,4 +35,4 @@ If the proposed change will be large, please also indicate a way to do the chang
 
 > Are there any relevant PR comments, issues that led up to this, or articles referenced for why we made the given design choice? If so link them here!
 
-- {reference link}
+- \{reference link\}
diff --git a/docs/dev/development-setup.md b/docs/dev/development-setup.md
@@ -52,7 +52,7 @@ When testing a function under a variety of different inputs, we prefer to use [t
 
 All unit tests should use the testing package. Please see the testing package [README](../../testing/README.md) for more information.
 
-Test coverage is continuously deployed at <https://app.codecov.io/github/cosmos/ibc-go>. PRs that improve test coverage are welcome, but in general the test coverage should be used as a guidance for finding API use cases that are not covered by tests. We don't recommend adding tests that only improve coverage but not actually test a meaning use case.
+Test coverage is continuously deployed at [codecov](https://app.codecov.io/github/cosmos/ibc-go). PRs that improve test coverage are welcome, but in general the test coverage should be used as a guidance for finding API use cases that are not covered by tests. We don't recommend adding tests that only improve coverage but not actually test a meaning use case.
 
 ## Documentation
 

diff --git a/docs/docs/01-ibc/03-apps/01-apps.md b/docs/docs/01-ibc/03-apps/01-apps.md
@@ -7,7 +7,7 @@ slug: /ibc/apps/apps
 
 # IBC Applications
 
-Learn how to configure your application to use IBC and send data packets to other chains. {synopsis}
+Learn how to configure your application to use IBC and send data packets to other chains.
 
 This document serves as a guide for developers who want to write their own Inter-blockchain
 Communication Protocol (IBC) applications for custom use cases.

diff --git a/docs/docs/02-apps/01-transfer/05-events.md b/docs/docs/02-apps/01-transfer/05-events.md
@@ -12,8 +12,8 @@ slug: /apps/transfer/events
 
 | Type         | Attribute Key | Attribute Value |
 |--------------|---------------|-----------------|
-| ibc_transfer | sender        | {sender}        |
-| ibc_transfer | receiver      | {receiver}      |
+| ibc_transfer | sender        | \{sender\}      |
+| ibc_transfer | receiver      | \{receiver\}    |
 | message      | action        | transfer        |
 | message      | module        | transfer        |
 
@@ -22,33 +22,33 @@ slug: /apps/transfer/events
 | Type                  | Attribute Key | Attribute Value |
 |-----------------------|---------------|-----------------|
 | fungible_token_packet | module        | transfer        |
-| fungible_token_packet | sender        | {sender}        |
-| fungible_token_packet | receiver      | {receiver}      |
-| fungible_token_packet | denom         | {denom}         |
-| fungible_token_packet | amount        | {amount}        |
-| fungible_token_packet | success       | {ackSuccess}    |
-| fungible_token_packet | memo          | {memo}          |
-| denomination_trace    | trace_hash    | {hex_hash}      |
+| fungible_token_packet | sender        | \{sender\}      | 
+| fungible_token_packet | receiver      | \{receiver\}    | 
+| fungible_token_packet | denom         | \{denom\}       | 
+| fungible_token_packet | amount        | \{amount\}      | 
+| fungible_token_packet | success       | \{ackSuccess\}  | 
+| fungible_token_packet | memo          | \{memo\}        | 
+| denomination_trace    | trace_hash    | \{hex_hash\}    | 
 
 ## `OnAcknowledgePacket` callback
 
 | Type                  | Attribute Key   | Attribute Value   |
 |-----------------------|-----------------|-------------------|
 | fungible_token_packet | module          | transfer          |
-| fungible_token_packet | sender          | {sender}          |
-| fungible_token_packet | receiver        | {receiver}        |
-| fungible_token_packet | denom           | {denom}           |
-| fungible_token_packet | amount          | {amount}          |
-| fungible_token_packet | memo            | {memo}            |
-| fungible_token_packet | acknowledgement | {ack.String()}    |
-| fungible_token_packet | success | error | {ack.Response}    |
+| fungible_token_packet | sender          | \{sender\}        |
+| fungible_token_packet | receiver        | \{receiver\}      |
+| fungible_token_packet | denom           | \{denom\}         |
+| fungible_token_packet | amount          | \{amount\}        |
+| fungible_token_packet | memo            | \{memo\}          |
+| fungible_token_packet | acknowledgement | \{ack.String()\}  |
+| fungible_token_packet | success | error | \{ack.Response\}  |
 
 ## `OnTimeoutPacket` callback
 
 | Type                  | Attribute Key   | Attribute Value |
 |-----------------------|-----------------|-----------------|
 | fungible_token_packet | module          | transfer        |
-| fungible_token_packet | refund_receiver | {receiver}      |
-| fungible_token_packet | denom           | {denom}         |
-| fungible_token_packet | amount          | {amount}        |
-| fungible_token_packet | memo            | {memo}          |
+| fungible_token_packet | refund_receiver | \{receiver\}    |
+| fungible_token_packet | denom           | \{denom\}       |
+| fungible_token_packet | amount          | \{amount\}      |
+| fungible_token_packet | memo            | \{memo\}        |
diff --git a/docs/docs/02-apps/02-interchain-accounts/10-legacy/01-auth-modules.md b/docs/docs/02-apps/02-interchain-accounts/10-legacy/01-auth-modules.md
@@ -166,7 +166,7 @@ if err := proto.Unmarshal(ack.GetResult(), txMsgData); err != nil {
 }
 ```
 
-If the `txMsgData.Data` field is non nil, the host chain is using SDK version <= v0.45.
+If the `txMsgData.Data` field is non nil, the host chain is using SDK version \<\= v0.45.
 The auth module should interpret the `txMsgData.Data` as follows:
 
 ```go

diff --git a/docs/docs/03-light-clients/04-wasm/01-overview.md b/docs/docs/03-light-clients/04-wasm/01-overview.md
@@ -9,7 +9,7 @@ slug: /ibc/light-clients/wasm/overview
 
 ## Overview
 
-Learn about the `08-wasm` light client proxy module. {synopsis}
+Learn about the `08-wasm` light client proxy module. 
 
 ### Context
 

diff --git a/docs/docs/03-light-clients/04-wasm/02-concepts.md b/docs/docs/03-light-clients/04-wasm/02-concepts.md
@@ -7,7 +7,7 @@ slug: /ibc/light-clients/wasm/concepts
 
 # Concepts
 
-Learn about the differences between a proxy light client and a Wasm light client. {synopsis}
+Learn about the differences between a proxy light client and a Wasm light client. 
 
 ## Proxy light client
 

diff --git a/docs/docs/03-light-clients/04-wasm/03-integration.md b/docs/docs/03-light-clients/04-wasm/03-integration.md
@@ -7,7 +7,7 @@ slug: /ibc/light-clients/wasm/integration
 
 # Integration
 
-Learn how to integrate the `08-wasm` module in a chain binary and about the recommended approaches depending on whether the [`x/wasm` module](https://github.com/CosmWasm/wasmd/tree/main/x/wasm) is already used in the chain. The following document only applies for Cosmos SDK chains. {synopsis}
+Learn how to integrate the `08-wasm` module in a chain binary and about the recommended approaches depending on whether the [`x/wasm` module](https://github.com/CosmWasm/wasmd/tree/main/x/wasm) is already used in the chain. The following document only applies for Cosmos SDK chains. 
 
 ## `app.go` setup
 

diff --git a/docs/docs/03-light-clients/04-wasm/05-governance.md b/docs/docs/03-light-clients/04-wasm/05-governance.md
@@ -7,7 +7,7 @@ slug: /ibc/light-clients/wasm/governance
 
 # Governance
 
-Learn how to upload Wasm light client byte code on a chain, and how to migrate an existing Wasm light client contract. {synopsis}
+Learn how to upload Wasm light client byte code on a chain, and how to migrate an existing Wasm light client contract. 
 
 ## Setting an authority
 

diff --git a/docs/docs/03-light-clients/04-wasm/06-events.md b/docs/docs/03-light-clients/04-wasm/06-events.md
@@ -11,16 +11,16 @@ The `08-wasm` module emits the following events:
 
 ## `MsgStoreCode`
 
-| Type             | Attribute Key  | Attribute Value        |
-|------------------|----------------|------------------------|
-| store_wasm_code  | wasm_checksum  | {hex.Encode(checksum)} |
-| message          | module         | 08-wasm                |
+| Type             | Attribute Key  | Attribute Value          |
+|------------------|----------------|--------------------------|
+| store_wasm_code  | wasm_checksum  | \{hex.Encode(checksum)\} |
+| message          | module         | 08-wasm                  |
 
 ## `MsgMigrateContract`
 
-| Type             | Attribute Key  | Attribute Value           |
-|------------------|----------------|---------------------------|
-| migrate_contract | client_id      | {clientId}                |
-| migrate_contract | wasm_checksum  | {hex.Encode(checksum)}    |
-| migrate_contract | new_checksum   | {hex.Encode(newChecksum)} |
-| message          | module         | 08-wasm                   |
+| Type             | Attribute Key  | Attribute Value             |
+|------------------|----------------|-----------------------------|
+| migrate_contract | client_id      | \{clientId\}                |
+| migrate_contract | wasm_checksum  | \{hex.Encode(checksum)\}    |
+| migrate_contract | new_checksum   | \{hex.Encode(newChecksum)\} |
+| message          | module         | 08-wasm                     |
diff --git a/docs/docs/03-light-clients/04-wasm/07-contracts.md b/docs/docs/03-light-clients/04-wasm/07-contracts.md
@@ -7,7 +7,7 @@ slug: /ibc/light-clients/wasm/contracts
 
 # Contracts
 
-Learn about the expected behaviour of Wasm light client contracts and the between with `08-wasm`. {synopsis}
+Learn about the expected behaviour of Wasm light client contracts and the between with `08-wasm`. 
 
 ## API
 

diff --git a/docs/docs/04-middleware/01-ics29-fee/05-events.md b/docs/docs/04-middleware/01-ics29-fee/05-events.md
@@ -16,28 +16,28 @@ An overview of all events related to ICS-29
 
 | Type                    | Attribute Key   | Attribute Value |
 | ----------------------- | --------------- | --------------- |
-| incentivized_ibc_packet | port_id         | {portID}        |
-| incentivized_ibc_packet | channel_id      | {channelID}     |
-| incentivized_ibc_packet | packet_sequence | {sequence}      |
-| incentivized_ibc_packet | recv_fee        | {recvFee}       |
-| incentivized_ibc_packet | ack_fee         | {ackFee}        |
-| incentivized_ibc_packet | timeout_fee     | {timeoutFee}    |
+| incentivized_ibc_packet | port_id         | \{portID\}      |
+| incentivized_ibc_packet | channel_id      | \{channelID\}   |
+| incentivized_ibc_packet | packet_sequence | \{sequence\}    |
+| incentivized_ibc_packet | recv_fee        | \{recvFee\}     |
+| incentivized_ibc_packet | ack_fee         | \{ackFee\}      |
+| incentivized_ibc_packet | timeout_fee     | \{timeoutFee\}  |
 | message                 | module          | fee-ibc         |
 
 ## `RegisterPayee`
 
 | Type           | Attribute Key | Attribute Value |
 | -------------- | ------------- | --------------- |
-| register_payee | relayer       | {relayer}       |
-| register_payee | payee         | {payee}         |
-| register_payee | channel_id    | {channelID}     |
+| register_payee | relayer       | \{relayer\}     |
+| register_payee | payee         | \{payee\}       |
+| register_payee | channel_id    | \{channelID\}   |
 | message        | module        | fee-ibc         |
 
 ## `RegisterCounterpartyPayee`
 
-| Type                        | Attribute Key      | Attribute Value     |
-| --------------------------- | ------------------ | ------------------- |
-| register_counterparty_payee | relayer            | {relayer}           |
-| register_counterparty_payee | counterparty_payee | {counterpartyPayee} |
-| register_counterparty_payee | channel_id         | {channelID}         |
-| message                     | module             | fee-ibc             |
+| Type                        | Attribute Key      | Attribute Value       |
+| --------------------------- | ------------------ | --------------------- |
+| register_counterparty_payee | relayer            | \{relayer\}           |
+| register_counterparty_payee | counterparty_payee | \{counterpartyPayee\} |
+| register_counterparty_payee | channel_id         | \{channelID\}         |
+| message                     | module             | fee-ibc               |
diff --git a/docs/docs/04-middleware/02-callbacks/01-overview.md b/docs/docs/04-middleware/02-callbacks/01-overview.md
@@ -7,7 +7,7 @@ slug: /middleware/callbacks/overview
 
 # Overview
 
-Learn about what the Callbacks Middleware is, and how to build custom modules that utilize the Callbacks Middleware functionality {synopsis}
+Learn about what the Callbacks Middleware is, and how to build custom modules that utilize the Callbacks Middleware functionality 
 
 ## What is the Callbacks Middleware?
 

diff --git a/docs/docs/04-middleware/02-callbacks/02-integration.md b/docs/docs/04-middleware/02-callbacks/02-integration.md
@@ -7,7 +7,7 @@ slug: /middleware/callbacks/integration
 
 # Integration
 
-Learn how to integrate the callbacks middleware with IBC applications. The following document is intended for developers building on top of the Cosmos SDK and only applies for Cosmos SDK chains. {synopsis}
+Learn how to integrate the callbacks middleware with IBC applications. The following document is intended for developers building on top of the Cosmos SDK and only applies for Cosmos SDK chains. 
 
 The callbacks middleware is a minimal and stateless implementation of the IBC middleware interface. It does not have a keeper, nor does it store any state. It simply routes IBC middleware messages to the appropriate callback function, which is implemented by the secondary application. Therefore, it doesn't need to be registered as a module, nor does it need to be added to the module manager. It only needs to be added to the IBC application stack.
 

diff --git a/docs/docs/05-migrations/migration.template.md b/docs/docs/05-migrations/migration.template.md
@@ -1,4 +1,4 @@
-# Migrating from <old-version> to <new-version>
+# Migrating from \<old-version\> to \<new-version\>
 
 This guide provides instructions for migrating to a new version of ibc-go.
 

diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -1,8 +1,10 @@
 // @ts-check
 // Note: type annotations allow type checking and IDEs autocompletion
 
-const lightCodeTheme = require("prism-react-renderer/themes/github");
-const darkCodeTheme = require("prism-react-renderer/themes/dracula");
+import { Highlight, themes } from "prism-react-renderer";
+
+const lightCodeTheme = themes.github;
+const darkCodeTheme = themes.dracula;
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
@@ -248,7 +250,7 @@ const config = {
         ],
       },
     }),
-  themes: ["@saucelabs/theme-github-codeblock"],
+  themes: ["docusaurus-theme-github-codeblock"],
   plugins: [
     [
       "@docusaurus/plugin-content-docs",
-Original file line number
+Diff line change
@@ Expand Up @@
     }
     ```
-    If the `txMsgData.Data` field is non nil, the host chain is using SDK version <= v0.45.
+    If the `txMsgData.Data` field is non nil, the host chain is using SDK version \<\= v0.45.
     The auth module should interpret the `txMsgData.Data` as follows:
     ```go
@@ Expand Down @@