Skip to content

Commit b4dac2f

Browse files
author
Jason
authored
chore: update markdown content to comply with mdx v3 parsing rules (#809)
1 parent 514ebd5 commit b4dac2f

File tree

7 files changed

+17
-15
lines changed

7 files changed

+17
-15
lines changed

Diff for: hosting/static-website/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ dfx deploy
125125
## Testing
126126
The URL for the frontend depends on the canister ID. Local canister IDs can be obtained using `dfx canister id`, in this case `dfx canister id www`. When deployed, the URL will look like this:
127127

128-
**http://<ui_canister_id>.localhost:8000**
128+
**http://\{ui_canister_id\}.localhost:8000**
129129

130130
![Candid UI](README_images/website.png)
131131

Diff for: motoko/encrypted-notes-dapp/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -159,8 +159,8 @@ 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.
163-
- Run `docker rm -f <CONTAINER ID'\'>`.
162+
- Run `docker ps` and find the \<CONTAINER ID\> of encrypted_notes.
163+
- Run `docker rm -f <CONTAINER ID>`.
164164

165165
### Option 2: Manual deployment
166166
- #### Step 1: For Motoko deployment set environmental variable:

Diff for: motoko/hello/README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,11 @@ This sample is based on the default project created by running `dfx new` as desc
2222
The sample code is available from the [samples](https://github.com/dfinity/examples) repository in both [Motoko](https://github.com/dfinity/examples/tree/master/motoko/hello) and [Rust](https://github.com/dfinity/examples/tree/master/rust/hello).
2323

2424
Canister `hello`, whether implemented in Motoko or Rust, presents the same Candid interface:
25-
26-
service : {
27-
greet: (text) -> (text);
28-
}
25+
```candid
26+
service : {
27+
greet: (text) -> (text);
28+
}
29+
```
2930

3031
The frontend canister, `hello_assets`, displays an HTML page with a text box for the argument and a button for calling the function greet with that argument. The result of the call is displayed in a message box.
3132

Diff for: 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.

Diff for: motoko/minimal-counter-dapp/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ $ dfx canister id minimal_dapp
188188
rrkah-fqaaa-aaaaa-aaaaq-cai
189189
```
190190

191-
**http://<candid_canister_id>.localhost:8000/?id=<backend_canister_id>**
191+
**http://\{candid_canister_id\}.localhost:8000/?id=\<backend_canister_id\>**
192192

193193
![Candid UI](README_images/candid_ui.png)
194194

Diff for: rust/encrypted-notes-dapp/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -160,8 +160,8 @@ 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.
164-
- Run `docker rm -f <CONTAINER ID'\'>`.
163+
- Run `docker ps` and find the \<CONTAINER ID\> of encrypted_notes.
164+
- Run `docker rm -f <CONTAINER ID>`.
165165

166166
### Option 2: Manual deployment
167167
- #### Step 1: For Rust deployment set environmental variable:

Diff for: rust/hello/README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,11 @@ This sample is based on the default project created by running `dfx new` as desc
2222
The sample code is available from the [samples](https://github.com/dfinity/examples) repository in both [Motoko](https://github.com/dfinity/examples/tree/master/motoko/hello) and [Rust](https://github.com/dfinity/examples/tree/master/rust/hello).
2323

2424
Canister `hello`, whether implemented in Motoko or Rust, presents the same Candid interface:
25-
26-
service : {
27-
greet: (text) -> (text);
28-
}
25+
```candid
26+
service : {
27+
greet: (text) -> (text);
28+
}
29+
```
2930

3031
The frontend canister, `hello_assets`, displays an HTML page with a text box for the argument and a button for calling the function greet with that argument. The result of the call is displayed in a message box.
3132

0 commit comments

Comments
 (0)