Skip to content

Latest commit

 

History

History
244 lines (155 loc) · 5.73 KB

supported_md.md

File metadata and controls

244 lines (155 loc) · 5.73 KB

Follow MD rules below

This is the markdown formatting validated to be well rendered to Static HTML along with the PDF exportation. Please only use these validated formats

Markdown comments

<!-- Comments are written this way - not published -->
<!-- shortcut for comments: alt + shift + a -->

Paragraph

Always add a space after a punctuation mark to return to a new line. To create a new paragraph, add two spaces at the end of the line.

Here is my new paragraph is this one.

Title hierarchy

You don't have to care about numbering, this will be automatically done during rendering process.

# Title level 1
## Title level 2
### Title level 3
#### level 4
##### level 5
###### level 6

Rendering:

Bold text

**my bold text**

Rendering:

my bold text

Italic text

*my italic text*

Rendering:

my italic text

Create a note

> This is a note...

Rendering:

This is a note...

Code or CLI output

```plaintext
regress@rtme-mx-25> show version 
Hostname: rtme-mx-25
Model: mx480
Family: junos
Junos: 25.2I-20250303.0.2029
```

Rendering:

regress@rtme-mx-25> show version 
Hostname: rtme-mx-25
Model: mx480
Family: junos
Junos: 25.2I-20250303.0.2029

External Links

[external-link-name](https://www.example.com)

Rendering:

external-link-name

Internal reference/link to a section

If you want to refer to a given section inside the same markdown file, use:

[Go to this section](#<this is a section reference>)

If you want to refer to a given section inside another markdown file part of the same book, use:

[Go to this far section](chapterX.md#<this is a section reference>)

Rendering:

Go to this section

Internal reference inside the text body

Your internal reference other than a section is created like that - the anchorX (X is a random/incrementing number that must be choosen/managed by the Author). It has a only meaning for mkdocs and is not visible by the reader: 

[Internal-reference-name](#anchorX)

Then position your anchorX wherevever you want in the body by using this simple html code in your markdown file:

<a id="anchorX"></a>

Rendering:

Your internal reference other than a section is created like that - the anchorX (X is a random/incrementing number that must be choosen/managed by the Author). It has a only meaning for mkdocs and is not visible by the reader:

Internal-reference-name

Then position your anchorX wherevever you want in the body by using this simple html code in your markdown file:

Images

Add figure caption if needed - numbering will be managed by the tool. 

By default the image size is set to 70% and the image is clickable to open a "modal" for zooming in. They are also center automatically.

![your image caption](images/logo.png)

Rendering:

your image caption

Figure 1: your image caption

Image Caption numbering is incremented automatically and has a global significance.

If you want to override the default size of an image you should use the { width: x%} like below:

![a smaller image](images/logo.png){ width=20%} 

Rendering:

your image caption{ width=20%}

Figure 2: a smaller image

Footnote

my text that needs footnote[^1]

and on the bottom of the md file: 

[^1]: Put this to the end of the document, the footnote will be listed like this. Rendering will put the footnote on the right page - don't care about that.

Rendering:

my text that needs footnote1

and on the bottom of the md file:

Tables

Table: This is table caption 

| Header1  | header2 | header3  |
|:-|:-|:-|
| cell 1   | cell 2    | cell 3    |
| cell 1   | cell 2    | cell 3    |
| cell 1   | cell 2    | cell 3    |

Rendering:

Header1 header2 header3
cell 1 cell 2 cell 3
cell 1 cell 2 cell 3
cell 1 cell 2 cell 3

Table 1: This is table caption

Table Caption numbering is incremented automatically and has a global significance.

More info: Table in MD

List

This is a list:

- elem1
- elem2
- elem3

Rendering:

This is a list:

  • elem1
  • elem2
  • elem3

Latex math Formula

One formula:

$$
\frac{10^{6}}{\text{policer clock tick}_{\mu s}} = \frac{10^{6}}{\text{policer tick} \cdot 2^{5R}}
$$

Rendering:

$$ \frac{10^{6}}{\text{policer clock tick}_{\mu s}} = \frac{10^{6}}{\text{policer tick} \cdot 2^{5R}} $$

Need Help?: Go here

Hello, I'm the anchor1 :-) Go back to the section

Footnotes

  1. Put this to the end of the document, the footnote will be listed like this. Rendering will put the footnote on the right page - don't care about that. ↩