Plugin to extend MkDocs Material theme.
Project description
MkDocs Pymdownx Material Extras
A plugin for MkDocs -- specifically the MkDocs Material Theme.
Adds additional resources that are used in the PyMdown Extensions documentation, and other @facelessuser projects.
While this is not specifically meant for outside consumption, and was originally written for @facelessuser projects, it can be freely used if desired.
Files are copied from the pymdown-extensions project.
Instructions
This is bound to specific versions of MkDocs Material and PyMdown Extensions. It may sometimes be tied to betas.
Installation:
pip install mkdocs_pymdownx_material_extras
Add it to your your mkdocs.yml plugins. It is assuming you are using MkDocs Material. When doing so, remember to add
back the search plugin as it doesn't append to the plugins, but overrides the plugins:
plugins:
- search
- mkdocs_pymdownx_material_extras
Setup 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 color
The following Material primary/accent colors map to actual Dracula colors:
| Material | Dracula |
|---|---|
| red | red |
| pink | pink |
| purple | purple |
| deep-purple | purple |
| blue | blue |
| indigo | blue |
| light-blue | blue |
| cyan | cyan |
| teal | cyan |
| green | green |
| light-green | green |
| lime | green |
| yellow | yellow |
| amber | yellow |
| orange | orange |
| deep-orange | orange |
Sponsor Footer Link
If 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 Support
Mermaid 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.js
If 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.js
Also, setup your Mermaid diagrams:
markdown_extensions:
- pymdownx.superfences:
custom_fences:
# Mermaid diagrams
- name: diagram
class: diagram
format: !!python/name:pymdownx.superfences.fence_code_format
Then you can specify your Mermaid diagrams in diagram code blocks:
```diagram
...
```
Mermaid setups are provided per scheme. You can see the setup here. if you are trying to override them.
MathJax/KaTeX
Again, 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.js
KaTeX:
extra_javascript:
- https://cdn.jsdelivr.net/npm/katex@0.13.18/dist/katex.min.js
Lastly, 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-plugin
If 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file mkdocs_pymdownx_material_extras-2.1.tar.gz.
File metadata
- Download URL: mkdocs_pymdownx_material_extras-2.1.tar.gz
- Upload date:
- Size: 24.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.8.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ed7ac048375f786617aea9b4990a9ed616e9c7d4a001d50995a5771039a90509 |
|
| MD5 | a486106e361df3bf34fb46ca8d332e45 |
|
| BLAKE2b-256 | 574e3cddfa16a9f6c92f475f244d1b86d3331a97d0401b512ddd3d61bacd2a69 |
Provenance
File details
Details for the file mkdocs_pymdownx_material_extras-2.1-py3-none-any.whl.
File metadata
- Download URL: mkdocs_pymdownx_material_extras-2.1-py3-none-any.whl
- Upload date:
- Size: 24.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.8.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a0e9b7e6a2e4ae1bc2c82dc8ec3bf3827b82a959c3cef74e779271855c6e745e |
|
| MD5 | 19502f450f6068118d4ee2e7b3d8d0d2 |
|
| BLAKE2b-256 | 2c018300bb694ccb6c898f65f6987f1febbcceaba413afba01e477bf97d034ee |
