| Name | mkdocs-pymdownx-material-extras JSON |
| Version |
2.5.6
JSON |
| download |
| home_page | |
| Summary | Plugin to extend MkDocs Material theme. |
| upload_time | 2023-11-25 16:56:58 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | |
| keywords |
extensions
markdown
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# MkDocs Pymdownx Material Extras
A plugin for MkDocs -- specifically the [MkDocs Material Theme](https://github.com/squidfunk/mkdocs-material).
Adds additional resources that are used in the PyMdown Extensions documentation, and other
[@facelessuser](https://github.com/facelessuser) projects.
While this is not specifically meant for outside consumption, and was originally written for
[@facelessuser](https://github.com/facelessuser) projects, it can be freely used if desired.
Files are copied from the [pymdown-extensions project](https://github.com/facelessuser/pymdown-extensions/tree/master/docs/theme/assets/pymdownx-extras).
## 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 `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:
```yml
plugins:
- search
- mkdocs_pymdownx_material_extras
```
Setup your theme as follows:
```yml
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.
```yml
theme:
pymdownx:
sponsor: "https://github.com/sponsors/facelessuser"
```
## Mermaid Support
Mermaid support is baked in. Simply add the Mermaid script to your MkDocs config:
```yml
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:
```yml
extra_javascript:
- my_mermaid_config.js
- https://unpkg.com/mermaid@8.8.4/dist/mermaid.min.js
```
Also, setup your Mermaid diagrams:
```yml
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](https://github.com/facelessuser/pymdown-extensions/blob/main/docs/src/js/material-extra-3rdparty.js).
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:
```yml
extra_javascript:
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
```
KaTeX:
```yml
extra_javascript:
- https://cdn.jsdelivr.net/npm/katex@0.13.18/dist/katex.min.js
```
Lastly, setup Arithmatex:
```yml
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:
```yml
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
```
Raw data
{
"_id": null,
"home_page": "",
"name": "mkdocs-pymdownx-material-extras",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "extensions,markdown",
"author": "",
"author_email": "Isaac Muse <Isaac.Muse@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/59/98/d243be92767de4fa174053beea9dd25b53ed20a5ae55610b0a79c02bb6ca/mkdocs_pymdownx_material_extras-2.5.6.tar.gz",
"platform": null,
"description": "# MkDocs Pymdownx Material Extras\n\nA plugin for MkDocs -- specifically the [MkDocs Material Theme](https://github.com/squidfunk/mkdocs-material).\n\nAdds additional resources that are used in the PyMdown Extensions documentation, and other\n[@facelessuser](https://github.com/facelessuser) projects.\n\nWhile this is not specifically meant for outside consumption, and was originally written for\n[@facelessuser](https://github.com/facelessuser) projects, it can be freely used if desired.\n\nFiles are copied from the [pymdown-extensions project](https://github.com/facelessuser/pymdown-extensions/tree/master/docs/theme/assets/pymdownx-extras).\n\n## Instructions\n\nThis is bound to specific versions of MkDocs Material and PyMdown Extensions. It may sometimes be tied to betas.\n\nInstallation:\n\n```\npip install mkdocs_pymdownx_material_extras\n```\n\nAdd it to your `mkdocs.yml` plugins. It is assuming you are using MkDocs Material. When doing so, remember to add\nback the `search` plugin as it doesn't append to the plugins, but overrides the plugins:\n\n```yml\nplugins:\n - search\n - mkdocs_pymdownx_material_extras\n```\n\nSetup your theme as follows:\n\n```yml\ntheme:\n name: material # Must use Material theme\n custom_dir: docs/theme # If you have overrides, specify where to find them\n palette:\n scheme: dracula # This is how to enables the Dracula theme for dark. For light, it will use default Material with some tweaks.\n primary: deep purple # Primary colors\n accent: deep purple # accent color\n```\n\nThe following Material primary/accent colors map to actual Dracula colors:\n\nMaterial | Dracula\n----------- | -------\nred | red\npink | pink\npurple | purple\ndeep-purple | purple\nblue | blue\nindigo | blue\nlight-blue | blue\ncyan | cyan\nteal | cyan\ngreen | green\nlight-green | green\nlime | green\nyellow | yellow\namber | yellow\norange | orange\ndeep-orange | orange\n\n## Sponsor Footer Link\n\nIf you'd like to add the sponsor heart in the footer, add your sponsor link under the MkDocs theme options like so.\n\n```yml\ntheme:\n pymdownx:\n sponsor: \"https://github.com/sponsors/facelessuser\"\n```\n\n## Mermaid Support\n\nMermaid support is baked in. Simply add the Mermaid script to your MkDocs config:\n\n```yml\nextra_javascript:\n - https://unpkg.com/mermaid@8.8.4/dist/mermaid.min.js\n```\n\nIf you do not like our default setup, you are free to modify it. Simply provide a script file before before you include\nMermaid with the new config:\n\n```yml\nextra_javascript:\n - my_mermaid_config.js\n - https://unpkg.com/mermaid@8.8.4/dist/mermaid.min.js\n```\nAlso, setup your Mermaid diagrams:\n\n```yml\nmarkdown_extensions:\n - pymdownx.superfences:\n custom_fences:\n # Mermaid diagrams\n - name: diagram\n class: diagram\n format: !!python/name:pymdownx.superfences.fence_code_format\n```\n\nThen you can specify your Mermaid diagrams in `diagram` code blocks:\n\n````\n```diagram\n...\n```\n````\n\nMermaid setups are provided per scheme. You can see the setup [here](https://github.com/facelessuser/pymdown-extensions/blob/main/docs/src/js/material-extra-3rdparty.js).\nif you are trying to override them.\n\n## MathJax/KaTeX\n\nAgain, MathJax and KaTeX support is baked in. Simply add the MathJax script(s) to your MkDocs config:\n\nMathJax:\n\n```yml\nextra_javascript:\n - https://polyfill.io/v3/polyfill.min.js?features=es6\n - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js\n```\n\nKaTeX:\n\n```yml\nextra_javascript:\n - https://cdn.jsdelivr.net/npm/katex@0.13.18/dist/katex.min.js\n```\n\nLastly, setup Arithmatex:\n\n```yml\nmarkdown_extensions:\n - pymdownx.arithmatex:\n generic: true # Must use generic mode\n block_tag: 'pre' # We wrap block math in `<pre>` to avoid issues with MkDocs minify HTML plugin: https://github.com/byrnereese/mkdocs-minify-plugin\n```\n\nIf you do not like the default MathJax setup, add your own config before MathJax script:\n\n```yml\nextra_javascript:\n - my_mathjax_config.js\n - https://polyfill.io/v3/polyfill.min.js?features=es6\n - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "Plugin to extend MkDocs Material theme.",
"version": "2.5.6",
"project_urls": {
"Homepage": "https://github.com/facelessuser/mkdocs_pymdownx_material_extras"
},
"split_keywords": [
"extensions",
"markdown"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "77d7ead76c2ec59e5795aa9bb2eac3480649ca7303b029c268feaf3de927208f",
"md5": "03fca19f029c0618e734b002900f2844",
"sha256": "ed5bfc23c6f42f485603e05abc22926c27c2b31ef9972a0132582b73f49557e9"
},
"downloads": -1,
"filename": "mkdocs_pymdownx_material_extras-2.5.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "03fca19f029c0618e734b002900f2844",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 27906,
"upload_time": "2023-11-25T16:56:57",
"upload_time_iso_8601": "2023-11-25T16:56:57.371337Z",
"url": "https://files.pythonhosted.org/packages/77/d7/ead76c2ec59e5795aa9bb2eac3480649ca7303b029c268feaf3de927208f/mkdocs_pymdownx_material_extras-2.5.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5998d243be92767de4fa174053beea9dd25b53ed20a5ae55610b0a79c02bb6ca",
"md5": "2541b8cb35d73dd2d65e5b437b2e5d7e",
"sha256": "e0cf0aa4f284a78ecab9caf0bc62a12d8b836a5abbd49f9638cc03b2698a021c"
},
"downloads": -1,
"filename": "mkdocs_pymdownx_material_extras-2.5.6.tar.gz",
"has_sig": false,
"md5_digest": "2541b8cb35d73dd2d65e5b437b2e5d7e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 25534,
"upload_time": "2023-11-25T16:56:58",
"upload_time_iso_8601": "2023-11-25T16:56:58.929029Z",
"url": "https://files.pythonhosted.org/packages/59/98/d243be92767de4fa174053beea9dd25b53ed20a5ae55610b0a79c02bb6ca/mkdocs_pymdownx_material_extras-2.5.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-25 16:56:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "facelessuser",
"github_project": "mkdocs_pymdownx_material_extras",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mkdocs-pymdownx-material-extras"
}
