help.md

Material for MkDocs Helper

Examples taken from https://squidfunk.github.io/mkdocs-material/reference/abbreviations/

Abbreviations

The HTML specification is maintained by the W3C.

*[HTML]: Hyper Text Markup Language *[W3C]: World Wide Web Consortium

Admonitions

!!! note Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.

??? note "closed note" Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.

???+ note "opened note" Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.

!!! summary abstract, summary, tldr

!!! info info, todo

!!! tip tip, hint, important

!!! success success, check, done

!!! question question, help, faq

!!! warning warning, caution, attention

!!! failure failure, fail, missing

!!! danger danger, error

!!! bug bug

!!! example example

!!! quote quote, cite

Buttons

Subscribe to our mailing list{: .md-button .md-button--primary }

Submit :fontawesome-solid-paper-plane:{: .md-button .md-button--primary }

Tables

Method	Description
GET	:material-check: Fetch resource
PUT	:material-check-all: Update resource
DELETE	:material-close: Delete resource

Formatting

Text can be {​--deleted--} and replacement text {​++added++}. This can also be combined into {​one~>a 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.

==}

• ==This was marked==

• ^^This was inserted^^

• This was deleted

• H20

• A^T^A

Emojis

😄

Images

{: align=left }

Lists

• Nulla et rhoncus turpis. Mauris ultricies elementum leo. Duis efficitur accumsan nibh eu mattis. Vivamus tempus velit eros, porttitor placerat nibh lacinia sed. Aenean in finibus diam.

  • Duis mollis est eget nibh volutpat, fermentum aliquet dui mollis.
  • Nam vulputate tincidunt fringilla.
  • Nullam dignissim ultrices urna non auctor.