Markdown
You can find complete MKDocs Material Documentation here.
Text Annotations
Highlight inner text
Simply write text between ``
Content Tabs
Just add === "TabName"
Unordered List
Just write * Text
Ordered List
Just write 1. Text
Admonition/callout with title
write !!! note/info/abstract/tip/question/success/ warning/failure "title"
with an indent with four spaces
for Collapsible just write ???
instead of !!!
Codeblocks
Plain codeblock
Simply write code block between ```
Codeblock for a specific language
Write the name of the code language after ```
like py, cshapr, shell, ...
Codeblock with a title
Write after ```
, title="bubble_sort.py
With line numbers
Write after ```
, linenums="1"
Highlighting lines
Write after ```
, hl_lines="2 3"
or hl_lines="1-6"
Icons and Emojs
write :smile:
for
write :fontawesome-regular-face-laugh-wink:
for
write :fontawesome-brands-twitter:{ .twitter }
for
write :octicons-heart-fill-24:{ .heart }
for