@@ -22,7 +22,7 @@ project:
2222
2323### Asciidoc syntax
2424
25- ` ` ` none
25+ ` ` ` markdown
2626[source,sh]
2727--------------------------------------------------
2828GET _tasks
@@ -33,28 +33,28 @@ GET _tasks?nodes=nodeId1,nodeId2&actions=cluster:*
3333
3434### Code blocks with callouts
3535
36- A code block can include ` <\d+> ` at the end to indicate code callouts.
37- A code block with this style of callouts ** needs** to be followed by an ordered list with an equal amount of items as called out.
36+ A code block can include ` <\d+> ` at the end to indicate code callouts.
37+ A code block with this style of callouts ** needs** to be followed by an ordered list with an equal amount of items as called out.
3838Otherwise, the docs-builder will throw an error.
3939
4040This syntax mimics what was implemented for our asciidoc system
4141
4242```` markdown
4343```yaml
4444project:
45- title: MyST Markdown
45+ title: MyST Markdown
4646 github: https://github.com/jupyter-book/mystmd
4747 license:
4848 code: MIT
4949 content: CC-BY-4.0 <1>
50- subject: MyST Markdown
50+ subject: MyST Markdown
5151```
5252
53531. The license
5454````
5555
5656
57- ### Magic Callout
57+ ### Magic Callout
5858
5959You can include the callouts also directly as code using either ` // ` or ` # ` comments.
6060
@@ -63,26 +63,26 @@ These will then be listed and numbered automatically
6363```` markdown
6464```csharp
6565var apiKey = new ApiKey("<API_KEY>"); // Set up the api key
66- var client = new ElasticsearchClient("<CLOUD_ID>", apiKey);
66+ var client = new ElasticsearchClient("<CLOUD_ID>", apiKey);
6767```
6868````
6969
7070Will output:
7171
7272``` csharp
7373var apiKey = new ApiKey (" <API_KEY>" ); // Set up the api key
74- var client = new ElasticsearchClient (" <CLOUD_ID>" , apiKey );
74+ var client = new ElasticsearchClient (" <CLOUD_ID>" , apiKey );
7575```
7676
77- ``` {note}
77+ ``` {note}
7878the comments have the follow code to be hoisted as a callout.
7979```
8080
8181```` markdown
8282```csharp
8383// THIS IS NOT A CALLOUT
8484var apiKey = new ApiKey("<API_KEY>"); // However this is
85- var client = new ElasticsearchClient("<CLOUD_ID>", apiKey);
85+ var client = new ElasticsearchClient("<CLOUD_ID>", apiKey);
8686```
8787````
8888
@@ -91,5 +91,5 @@ will output:
9191``` csharp
9292// THIS IS NOT A CALLOUT
9393var apiKey = new ApiKey (" <API_KEY>" ); // However this is
94- var client = new ElasticsearchClient (" <CLOUD_ID>" , apiKey );
94+ var client = new ElasticsearchClient (" <CLOUD_ID>" , apiKey );
9595```
0 commit comments