https://squidfunk.github.io/mkdocs-material/reference
Abbreviations
AWS is awesome.
AWS is Abbreviations
Look into
abbreviations.md
and don't forget to include this in the bottom of the current page via--8<-- "/docs/team/general/abbreviations.md"
Admonitions
we could customize admotion title
Attention, please
admotion is awesome
Info
I'm spoiler
Annotations
TODO: for some reason annotations work's only in code annotations=/
- :man_raising_hand: I'm a code annotation! I can contain
code
, formatted text, images, ... basically anything that can be written in Markdown.
Code blocks
def bubble_sort(items):
for i in range(len(items)):
for j in range(len(items) - 1 - i):
if items[j] > items[j + 1]:
items[j], items[j + 1] = items[j + 1], items[j]
The range()
function is used to generate a sequence of numbers.
Content Tabs
Code
Regular tabs
- Sed sagittis eleifend rutrum
- Donec vitae suscipit est
- Nulla tempor lobortis orci
- Sed sagittis eleifend rutrum
- Donec vitae suscipit est
- Nulla tempor lobortis orci
Admotions
Tabs inside the admotions
Data tables
Method | Description |
---|---|
GET |
![]() |
PUT |
![]() |
DELETE |
![]() |
Diagrams (Meramid)
Info
If you are familiar with Markdown you should have no problem learning [Mermaid's Syntax](https://mermaid-js.github.io/mermaid/#/./n00b-syntaxReference)
Footnotes
Lorem ipsum1 dolor sit amet, consectetur adipiscing elit.2
Formatting
Text can be deleted and replacement text added. This can also be
combined into onea single operation. Highlighting is also
possible and comments can be added inline.
Formatting can also be applied to blocks by putting the opening and closing tags on separate lines and adding new lines between the tags and the content.
emojis
That's in the background is me in my
Images
Warning
NOTE: Imgur reject CORS request
Youtube
Lists
List of Lists
-
Vivamus id mi enim. Integer id turpis sapien. Ut condimentum lobortis sagittis. Aliquam purus tellus, faucibus eget urna at, iaculis venenatis nulla. Vivamus a pharetra leo.
-
Vivamus venenatis porttitor tortor sit amet rutrum. Pellentesque aliquet quam enim, eu volutpat urna rutrum a. Nam vehicula nunc mauris, a ultricies libero efficitur sed.
-
Morbi eget dapibus felis. Vivamus venenatis porttitor tortor sit amet rutrum. Pellentesque aliquet quam enim, eu volutpat urna rutrum a.
- Mauris dictum mi lacus
- Ut sit amet placerat ante
- Suspendisse ac eros arcu
-
Task lists
- Lorem ipsum dolor sit amet, consectetur adipiscing elit
- Vestibulum convallis sit amet nisi a tincidunt
- In hac habitasse platea dictumst
- In scelerisque nibh non dolor mollis congue sed et metus
- Praesent sed risus massa
- Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque