Skip to content

Material for mkdocs Formatting⚓︎

Admonitions⚓︎

See: Material for mkdocs: 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.

Summary

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.

Info

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.

Custom Title

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.

Code Blocks⚓︎

See: Material for mkdocs: Code Blocks

# This is a Python code block.
print("Hello world!") if __name__ == "__main__"
1
2
# This is a JavaScript code block with line numbers.
( _ => console.log("Hello world!"))();
# This is a Markdown code block with line highlights and nested code block.
    ``` js
    ( _ => console.log("Hello world!"))();
    ```

This is an inline Java highlight system.out.println("Hello world!")

Content Tabs⚓︎

See: Material for mkdocs: Content Tabs

Basic Tabs⚓︎

=== "Tab 1"
    Hello
=== "Tab 2"
    World

Hello

World

Tabs in Admonitions with Code Blocks⚓︎

!!! example
    "Hello world" in many languages:
    === "Python"
        ```python
        print("Hello world!") if __name__ == "__main__"
        ```
    === "JavaScript"
        ```js
        ( _ => console.log("Hello world!"))();
        ```

Example

"Hello world" in many languages:

print("Hello world!") if __name__ == "__main__"
( _ => console.log("Hello world!"))();

Data Tables⚓︎

See: Material for mkdocs: Data Tables

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