chore: Update markdown for mdx v3 (#825)

* chore: update markdown content to comply with mdx v3 parsing rules * chore: update markdown content to comply with mdx v3 parsing rules * chore: update markdown content to comply with mdx v3 parsing rules * chore: update markdown content to comply with mdx v3 parsing rules
dfinity · Apr 4, 2024 · c4f9901 · c4f9901
1 parent b74ee4f
commit c4f9901
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 15 deletions.
diff --git a/hosting/godot-html5-template/README.md b/hosting/godot-html5-template/README.md
@@ -41,7 +41,7 @@ When the local replica is up and running, run this command to deploy the caniste
 dfx deploy
 ```
 
-If you get error code 500 after deploying to the IC mainnet, try to use `raw` keyword in the URL like this: `https://\<canister-id\>.raw.ic0.app`.
+If you get error code 500 after deploying to the IC mainnet, try to use `raw` keyword in the URL like this: `https://<canister-id>.raw.ic0.app`.
 
 ## License
 This project is licensed under the Apache 2.0 license, see `LICENSE.md` for details. See `CONTRIBUTE.md` for details about how to contribute to this project. 
diff --git a/hosting/unity-webgl-template/README.md b/hosting/unity-webgl-template/README.md
@@ -42,7 +42,7 @@ dfx deploy
 If you get error code 500 after deploying to the IC mainnet, try to use `raw` keyword in the URL like this: 
 
 ```
-https://\<canister-id\>.raw.ic0.app
+https://<canister-id>.raw.ic0.app
 ```
 
 ## License

diff --git a/motoko/encrypted-notes-dapp/README.md b/motoko/encrypted-notes-dapp/README.md
@@ -159,7 +159,7 @@ sh ./deploy_locally.sh
 
 - #### Step 5: To stop the docker instance:
    - Hit **Ctrl+C** on your keyboard to abort the running process.
-   - Run `docker ps` and find the \<CONTAINER ID\> of encrypted_notes.
+   - Run `docker ps` and find the `<CONTAINER ID>` of encrypted_notes.
    - Run `docker rm -f <CONTAINER ID>`.
 
 ### Option 2: Manual deployment

diff --git a/motoko/internet_identity_integration/README.md b/motoko/internet_identity_integration/README.md
@@ -102,7 +102,7 @@ Open the `internet_identity` link in the browser. You should be able to create a
 ### Step 4: Make the Internet Identity URL available in the build process.
 We want the sample application to integrate with Internet Identity differently depending on whether we deploy locally or on mainnet:
 
-- Locally the application should use the Internet Identity URL http://\<II_CANISTER_ID\>.localhost:4943/.
+- Locally the application should use the Internet Identity URL `http://<II_CANISTER_ID>.localhost:4943/`.
 - On the mainnet it should use https://identity.ic0.app.
 
 > **Note**: If you are using Safari (or any other browser that does not support subdomains on localhost, i.e this URL `http://<II_CANISTER_ID>.localhost:4943/`), you can try to use the following URL instead: `http://localhost:4943/?canisterId=<II_CANISTER_ID>`. This will work for Safari but not Chrome.

diff --git a/native-apps/unity_ii_applink/unity_project/README.md b/native-apps/unity_ii_applink/unity_project/README.md
@@ -22,30 +22,30 @@ There're several important files in this example.
   It's a plugin which provides functions to open the web browser, handle the App Link activation, and composite the `DelegationIdentity` from Json string.
 
 - [GreetingClient.cs](./Assets/Scripts/GreetingClient.cs)  
-  This provides the C# APIs for calling the Greeting backend canister in [ii_integration_dapp](../ii_integration_dapp/README.md). It can be generated by running the `ClientGenerator` provided by [ICP.NET](https://github.com/BoomDAO/ICP.NET).
+  This provides the C# APIs for calling the Greeting backend canister in [ii_integration_dapp](https://github.com/dfinity/examples/blob/master/native-apps/unity_ii_applink/ii_integration_dapp/README.md). It can be generated by running the `ClientGenerator` provided by [ICP.NET](https://github.com/BoomDAO/ICP.NET).
 
 - [TestICPAgent.cs](./Assets/Scripts/TestICPAgent.cs)  
   This is a testing script which can parse the delegation identity and call the APIs provided by [GreetingClient.cs](./Assets/Scripts/GreetingClient.cs) to communicate with the greeting backend canister.
 
 ## Deployment
 
-The current Unity project is configured to use the [deployed dapp](https://6x7nu-oaaaa-aaaan-qdaua-cai.icp0.io), its `assetlinks.json` file contains the `SHA256` value from the [test.keystore file](./Assets/test.keystore) (the passwords for the keystore and `ii-test` key are both `unity123456`). If you deploy your own dapp by following [ii_integration_dapp](../ii_integration_dapp/README.md), you need to make some modifications before you start to build this project to Android platform in Unity.
+The current Unity project is configured to use the [deployed dapp](https://6x7nu-oaaaa-aaaan-qdaua-cai.icp0.io), its `assetlinks.json` file contains the `SHA256` value from the [test.keystore file](./Assets/test.keystore) (the passwords for the keystore and `ii-test` key are both `unity123456`). If you deploy your own dapp by following [ii_integration_dapp](https://github.com/dfinity/examples/blob/master/native-apps/unity_ii_applink/ii_integration_dapp/README.md), you need to make some modifications before you start to build this project to Android platform in Unity.
 
 1. In Unity, open the `Assets\Scenes\SampleScene.unity`.
 2. Navigate to the `AgentAndPlugin` in the scene hierarchy.
 3. Update the `Greet Backend Canister` with your own greeting backend canister id.
 4. Update the `Greet Frontend` with your own greeting frontend.
-5. If you use a different URL scheme to launch your Unity project in [ii_integration_dapp](../ii_integration_dapp/README.md), please update the `kAndroidScheme`, `kAndroidHost` and `kURLPath` in [AndroidPostBuildProcessor.cs](./Assets/Editor/AndroidPostBuildProcessor.cs) accordingly.
-6. Naviagte to `Editor -> Project Settings -> Android -> Publishing Settings`, choose the keystore file which contains the same `SHA256` value that you use to in your [assetlinks.json file](../ii_integration_dapp/src/greet_frontend/assets/.well-known/assetlinks.json).
+5. If you use a different URL scheme to launch your Unity project in [ii_integration_dapp](https://github.com/dfinity/examples/blob/master/native-apps/unity_ii_applink/ii_integration_dapp/README.md), please update the `kAndroidScheme`, `kAndroidHost` and `kURLPath` in [AndroidPostBuildProcessor.cs](./Assets/Editor/AndroidPostBuildProcessor.cs) accordingly.
+6. Naviagte to `Editor -> Project Settings -> Android -> Publishing Settings`, choose the keystore file which contains the same `SHA256` value that you use to in your [assetlinks.json file](https://github.com/dfinity/examples/blob/master/native-apps/unity_ii_applink/ii_integration_dapp/src/greet_frontend/assets/.well-known/assetlinks.json).
 
-After updating your Unity project correctly, please build to Android platform in Unity, just 
+After updating your Unity project correctly, please build to Android platform in Unity, just
 1. Go to `File -> Build Settings` window.
 2. Switch to `Android` platform.
 3. Click `Build` to build the Android app, or Click `Build And Run` to build and run on the connected device.
 
 ## Verification
 
-While installing your app on your Android devices, the Android installer will fetch the [assetlinks.json file](../ii_integration_dapp/src/greet_frontend/assets/.well-known/assetlinks.json) from the website and verify the `SHA256` value. But sometimes the verification might fail due to reasons like an unstable network. Once you find the Android App Links doesn't work as you expected, you can run the below [adb command](https://developer.android.com/tools/adb) to retrieve the domain verification status of your apps.
+While installing your app on your Android devices, the Android installer will fetch the [assetlinks.json file](https://github.com/dfinity/examples/blob/master/native-apps/unity_ii_applink/ii_integration_dapp/src/greet_frontend/assets/.well-known/assetlinks.json) from the website and verify the `SHA256` value. But sometimes the verification might fail due to reasons like an unstable network. Once you find the Android App Links doesn't work as you expected, you can run the below [adb command](https://developer.android.com/tools/adb) to retrieve the domain verification status of your apps.
 
 ```
 adb shell pm get-app-links <your-package-name>

diff --git a/native-apps/unity_ii_deeplink/unity_project/README.md b/native-apps/unity_ii_deeplink/unity_project/README.md
@@ -25,24 +25,24 @@ There're several important files in this example.
   It's a plugin which provides functions to open the web browser, handle the DeepLink activation, and composite the `DelegationIdentity` from Json string.
 
 - [GreetingClient.cs](./Assets/Scripts/GreetingClient.cs)  
-  This provides the C# APIs for calling the Greeting backend canister in [ii_integration_dapp](../ii_integration_dapp/README.md). It can be generated by running the `ClientGenerator` provided by [ICP.NET](https://github.com/BoomDAO/ICP.NET).
+  This provides the C# APIs for calling the Greeting backend canister in [ii_integration_dapp](https://github.com/dfinity/examples/blob/master/native-apps/unity_ii_deeplink/ii_integration_dapp/README.md). It can be generated by running the `ClientGenerator` provided by [ICP.NET](https://github.com/BoomDAO/ICP.NET).
 
 - [TestICPAgent.cs](./Assets/Scripts/TestICPAgent.cs)  
   This is a testing script which calls the APIs provided by [GreetingClient.cs](./Assets/Scripts/GreetingClient.cs) to communicate with the greeting backend canister.
 
 ## Deployment
 
-The current Unity project is configured to use the [deployed dapp](https://6x7nu-oaaaa-aaaan-qdaua-cai.icp0.io). If you deploy your own dapp by following [ii_integration_dapp](../ii_integration_dapp/README.md), you need to make some modifications before you start to build this project to mobile platforms in Unity.
+The current Unity project is configured to use the [deployed dapp](https://6x7nu-oaaaa-aaaan-qdaua-cai.icp0.io). If you deploy your own dapp by following [ii_integration_dapp](https://github.com/dfinity/examples/blob/master/native-apps/unity_ii_deeplink/ii_integration_dapp/README.md), you need to make some modifications before you start to build this project to mobile platforms in Unity.
 
 1. In Unity, open the `Assets\Scenes\SampleScene.unity`
 2. Navigate to the `AgentAndPlugin` in the scene hierarchy
 3. Update the `Greet Backend Canister` with your own greeting backend canister id
 4. Update the `Greet Frontend` with your own greeting frontend
-5. If you use a different URL scheme to launch your Unity project in [ii_integration_dapp](../ii_integration_dapp/README.md), please 
+5. If you use a different URL scheme to launch your Unity project in [ii_integration_dapp](https://github.com/dfinity/examples/blob/master/native-apps/unity_ii_deeplink/ii_integration_dapp/README.md), please
     - Update the `kAndroidScheme` & `kAndroidHost` in [AndroidPostBuildProcessor.cs](./Assets/Editor/AndroidPostBuildProcessor.cs) accordingly.
     - Or update the `kURLScheme` & `kURLIdentifier` in [iOSPostBuildProcessor.cs](./Assets/Editor/iOSPostBuildProcessor.cs) accordingly.
 
-After updating your Unity project correctly, please build to the platform you want to build to in Unity, just 
+After updating your Unity project correctly, please build to the platform you want to build to in Unity, just
 1. Go to `File -> Build Settings` window
 2. Switch to `Android` / `iOS` platform
 3. Click `Build` to build the app, or Click `Build And Run` to build and run on the connected device.
diff --git a/rust/encrypted-notes-dapp/README.md b/rust/encrypted-notes-dapp/README.md
@@ -160,7 +160,7 @@ sh ./deploy_locally.sh
 
 - #### Step 5: To stop the docker instance:
    - Hit **Ctrl+C** on your keyboard to abort the running process.
-   - Run `docker ps` and find the \<CONTAINER ID\> of encrypted_notes.
+   - Run `docker ps` and find the `<CONTAINER ID>` of encrypted_notes.
    - Run `docker rm -f <CONTAINER ID>`.
 
 ### Option 2: Manual deployment