Skip to content

Commit c4f9901

Browse files
author
Jason
authored
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
1 parent b74ee4f commit c4f9901

File tree

7 files changed

+15
-15
lines changed

7 files changed

+15
-15
lines changed

hosting/godot-html5-template/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ When the local replica is up and running, run this command to deploy the caniste
4141
dfx deploy
4242
```
4343

44-
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`.
44+
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`.
4545

4646
## License
4747
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.

hosting/unity-webgl-template/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ dfx deploy
4242
If you get error code 500 after deploying to the IC mainnet, try to use `raw` keyword in the URL like this:
4343

4444
```
45-
https://\<canister-id\>.raw.ic0.app
45+
https://<canister-id>.raw.ic0.app
4646
```
4747

4848
## License

motoko/encrypted-notes-dapp/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ sh ./deploy_locally.sh
159159

160160
- #### Step 5: To stop the docker instance:
161161
- Hit **Ctrl+C** on your keyboard to abort the running process.
162-
- Run `docker ps` and find the \<CONTAINER ID\> of encrypted_notes.
162+
- Run `docker ps` and find the `<CONTAINER ID>` of encrypted_notes.
163163
- Run `docker rm -f <CONTAINER ID>`.
164164

165165
### Option 2: Manual deployment

motoko/internet_identity_integration/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Open the `internet_identity` link in the browser. You should be able to create a
102102
### Step 4: Make the Internet Identity URL available in the build process.
103103
We want the sample application to integrate with Internet Identity differently depending on whether we deploy locally or on mainnet:
104104

105-
- Locally the application should use the Internet Identity URL http://\<II_CANISTER_ID\>.localhost:4943/.
105+
- Locally the application should use the Internet Identity URL `http://<II_CANISTER_ID>.localhost:4943/`.
106106
- On the mainnet it should use https://identity.ic0.app.
107107

108108
> **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.

native-apps/unity_ii_applink/unity_project/README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -22,30 +22,30 @@ There're several important files in this example.
2222
It's a plugin which provides functions to open the web browser, handle the App Link activation, and composite the `DelegationIdentity` from Json string.
2323

2424
- [GreetingClient.cs](./Assets/Scripts/GreetingClient.cs)
25-
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).
25+
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).
2626

2727
- [TestICPAgent.cs](./Assets/Scripts/TestICPAgent.cs)
2828
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.
2929

3030
## Deployment
3131

32-
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.
32+
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.
3333

3434
1. In Unity, open the `Assets\Scenes\SampleScene.unity`.
3535
2. Navigate to the `AgentAndPlugin` in the scene hierarchy.
3636
3. Update the `Greet Backend Canister` with your own greeting backend canister id.
3737
4. Update the `Greet Frontend` with your own greeting frontend.
38-
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.
39-
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).
38+
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.
39+
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).
4040

41-
After updating your Unity project correctly, please build to Android platform in Unity, just
41+
After updating your Unity project correctly, please build to Android platform in Unity, just
4242
1. Go to `File -> Build Settings` window.
4343
2. Switch to `Android` platform.
4444
3. Click `Build` to build the Android app, or Click `Build And Run` to build and run on the connected device.
4545

4646
## Verification
4747

48-
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.
48+
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.
4949

5050
```
5151
adb shell pm get-app-links <your-package-name>

native-apps/unity_ii_deeplink/unity_project/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -25,24 +25,24 @@ There're several important files in this example.
2525
It's a plugin which provides functions to open the web browser, handle the DeepLink activation, and composite the `DelegationIdentity` from Json string.
2626

2727
- [GreetingClient.cs](./Assets/Scripts/GreetingClient.cs)
28-
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).
28+
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).
2929

3030
- [TestICPAgent.cs](./Assets/Scripts/TestICPAgent.cs)
3131
This is a testing script which calls the APIs provided by [GreetingClient.cs](./Assets/Scripts/GreetingClient.cs) to communicate with the greeting backend canister.
3232

3333
## Deployment
3434

35-
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.
35+
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.
3636

3737
1. In Unity, open the `Assets\Scenes\SampleScene.unity`
3838
2. Navigate to the `AgentAndPlugin` in the scene hierarchy
3939
3. Update the `Greet Backend Canister` with your own greeting backend canister id
4040
4. Update the `Greet Frontend` with your own greeting frontend
41-
5. If you use a different URL scheme to launch your Unity project in [ii_integration_dapp](../ii_integration_dapp/README.md), please
41+
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
4242
- Update the `kAndroidScheme` & `kAndroidHost` in [AndroidPostBuildProcessor.cs](./Assets/Editor/AndroidPostBuildProcessor.cs) accordingly.
4343
- Or update the `kURLScheme` & `kURLIdentifier` in [iOSPostBuildProcessor.cs](./Assets/Editor/iOSPostBuildProcessor.cs) accordingly.
4444

45-
After updating your Unity project correctly, please build to the platform you want to build to in Unity, just
45+
After updating your Unity project correctly, please build to the platform you want to build to in Unity, just
4646
1. Go to `File -> Build Settings` window
4747
2. Switch to `Android` / `iOS` platform
4848
3. Click `Build` to build the app, or Click `Build And Run` to build and run on the connected device.

rust/encrypted-notes-dapp/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ sh ./deploy_locally.sh
160160

161161
- #### Step 5: To stop the docker instance:
162162
- Hit **Ctrl+C** on your keyboard to abort the running process.
163-
- Run `docker ps` and find the \<CONTAINER ID\> of encrypted_notes.
163+
- Run `docker ps` and find the `<CONTAINER ID>` of encrypted_notes.
164164
- Run `docker rm -f <CONTAINER ID>`.
165165

166166
### Option 2: Manual deployment

0 commit comments

Comments
 (0)