MkDocs Material ¶

Is a theme for MkDocs that provides a clean and responsive design. It is based on the Material Design guidelines by Google. MkDocs is a static site generator that is geared towards building project documentation. It is written in Python and uses Markdown to create pages.

Info

Are pretty good resources for learning how to use MkDocs and MkDocs Material.

Admonitions¶

!!! tip "Title"

    Some content

Title

Some content

Available Tags¶

Tag	Icon	Description
`note`		General note
`abstract`		Summary of content
`info`		Informational note
`tip`		Helpful tip
`success`		Successful operation
`question`		Question
`warning`		Warning
`failure`		Failed operation
`danger`		Danger
`bug`		Bug notice
`example`		Example for illustration
`quote`		Quote

Code Blocks¶

```bash title="bash"
echo "Hello World"
```

bash

echo "Hello World"

Multi Tabbed Code Blocks¶

=== 'python'

    ```python
    print("Hello World")
    ```

=== 'javascript'

    ```javascript
    console.log("Hello World")
    ```

PythonJS

print("Hello World")

console.log("Hello World")

Mermaid¶

```mermaid
graph LR
    A[Hard] -->|Text| B(Round)
    B --> C{Decision}
    C -->|One| D[Result 1]
    C -->|Two| E[Result 2]
```

graph LR
    A[Hard] -->|Text| B(Round)
    B --> C{Decision}
    C -->|One| D[Result 1]
    C -->|Two| E[Result 2]

Math¶

$$
\operatorname{ker} f=\{g\in G:f(g)=e_{H}\}{\mbox{.}}
$$

\[ \operatorname{ker} f=\{g\in G:f(g)=e_{H}\}{\mbox{.}} \]