Skip to content

Mkdocs Material

mkdocs.yml

site_name: Notes
theme:
    name: material
    features:
        - content.code.annotate # (1)
    palette:
        scheme: default
        primary: white
markdown_extensions:
    - admonition
    - attr_list # (5)
    - md_in_html
    - pymdownx.snippets # (2)
    - pymdownx.details
    - pymdownx.tabbed: # (4)
        alternate_style: true
    - pymdownx.superfences: # (3)
        custom_fences:
            - name: mermaid
              class: mermaid
              format: !!python/name:pymdownx.superfences.fence_code_format
  1. This is a code annotation
  2. Snippets allow inclusions to be made from other files.
  3. Superfences allow code blocks to be palced inside tabs and admonitions.
  4. Tabbed allows tabs. Note that the alternate_style configuration is the only supported style and is required.
  5. Attribute lists are necessary for image alignment.

Audio

Audio clips require the md_in_html extension. Keep in mind that the filename of the audio will be appended to the route of the current page.

<audio controls="controls"><source type="audio/mp4" src="gabriela.m4a"></source></audio>