Package: mkdocs-pymdownx-material-extras
MkDocs Pymdownx Material ExtrasA plugin for MkDocs -- specifically theMkDocs Material Theme.Adds additional resources that are used in the PyMdown Extensions documentation, and other@facelessuserprojects.While this is not specifically meant for outside consumption, and was originally written for@facelessuserprojects, it can be freely used if desired.Files are copied from thepymdown-extensions project.InstructionsThis is bound to specific versions of MkDocs Material and PyMdown Extensions. It may sometimes be tied to betas.Installation:pip install mkdocs_pymdownx_material_extrasAdd it to yourmkdocs.ymlplugins. It is assuming you are using MkDocs Material. When doing so, remember to add
back thesearchplugin as it doesn't append to the plugins, but overrides the plugins:plugins:
  - search
  - mkdocs_pymdownx_material_extrasSetup your theme as follows:theme:
  name: material # Must use Material theme
  custom_dir: docs/theme # If you have overrides, specify where to find them
  palette:
    scheme: dracula # This is how to enables the Dracula theme for dark. For light, it will use default Material with some tweaks.
    primary: deep purple # Primary colors
    accent: deep purple # accent colorThe following Material primary/accent colors map to actual Dracula colors:MaterialDracularedredpinkpinkpurplepurpledeep-purplepurpleblueblueindigobluelight-bluebluecyancyantealcyangreengreenlight-greengreenlimegreenyellowyellowamberyelloworangeorangedeep-orangeorangeSponsor Footer LinkIf you'd like to add the sponsor heart in the footer, add your sponsor link under the MkDocs theme options like so.theme:
  pymdownx:
    sponsor: "https://github.com/sponsors/facelessuser"Mermaid SupportMermaid support is baked in. Simply add the Mermaid script to your MkDocs config:extra_javascript:
  - https://unpkg.com/mermaid@8.8.4/dist/mermaid.min.jsIf you do not like our default setup, you are free to modify it. Simply provide a script file before before you include
Mermaid with the new config:extra_javascript:
  - my_mermaid_config.js
  - https://unpkg.com/mermaid@8.8.4/dist/mermaid.min.jsAlso, setup your Mermaid diagrams:markdown_extensions:
  - pymdownx.superfences:
      custom_fences:
        # Mermaid diagrams
        - name: diagram
          class: diagram
          format: !!python/name:pymdownx.superfences.fence_code_formatThen you can specify your Mermaid diagrams indiagramcode blocks:```diagram
...
```Mermaid setups are provided per scheme. You can see the setuphere.
if you are trying to override them.MathJax/KaTeXAgain, MathJax and KaTeX support is baked in. Simply add the MathJax script(s) to your MkDocs config:MathJax:extra_javascript:
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.jsKaTeX:extra_javascript:
  - https://cdn.jsdelivr.net/npm/katex@0.13.18/dist/katex.min.jsLastly, setup Arithmatex:markdown_extensions:
  - pymdownx.arithmatex:
      generic: true # Must use generic mode
      block_tag: 'pre' # We wrap block math in `<pre>` to avoid issues with MkDocs minify HTML plugin: https://github.com/byrnereese/mkdocs-minify-pluginIf you do not like the default MathJax setup, add your own config before MathJax script:extra_javascript:
  - my_mathjax_config.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js