{"id":13593664,"url":"https://github.com/facelessuser/mkdocs_pymdownx_material_extras","last_synced_at":"2025-05-07T19:09:38.901Z","repository":{"id":39591611,"uuid":"242265260","full_name":"facelessuser/mkdocs_pymdownx_material_extras","owner":"facelessuser","description":"Custom alterations based on Mkdocs-Material","archived":false,"fork":false,"pushed_at":"2025-03-16T14:24:27.000Z","size":317,"stargazers_count":16,"open_issues_count":0,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-31T13:06:27.617Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/facelessuser.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-02-22T02:14:25.000Z","updated_at":"2025-03-16T14:18:26.000Z","dependencies_parsed_at":"2024-01-14T04:13:28.293Z","dependency_job_id":"a2f00cba-1499-410f-9a3e-c7decfba2cdc","html_url":"https://github.com/facelessuser/mkdocs_pymdownx_material_extras","commit_stats":{"total_commits":90,"total_committers":2,"mean_commits":45.0,"dds":"0.011111111111111072","last_synced_commit":"8535e43a8ad2682e98558878c67e774a0a1971ad"},"previous_names":[],"tags_count":61,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/facelessuser%2Fmkdocs_pymdownx_material_extras","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/facelessuser%2Fmkdocs_pymdownx_material_extras/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/facelessuser%2Fmkdocs_pymdownx_material_extras/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/facelessuser%2Fmkdocs_pymdownx_material_extras/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/facelessuser","download_url":"https://codeload.github.com/facelessuser/mkdocs_pymdownx_material_extras/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252270223,"owners_count":21721432,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T16:01:22.898Z","updated_at":"2025-05-07T19:09:38.854Z","avatar_url":"https://github.com/facelessuser.png","language":"Python","funding_links":["https://github.com/sponsors/facelessuser"],"categories":["Python"],"sub_categories":[],"readme":"# 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://cdn.jsdelivr.net/npm/mermaid@11.5.0/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://cdn.jsdelivr.net/npm/mermaid@11.5.0/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://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js\n```\n\nKaTeX:\n\n```yml\nextra_css:\n  - https://cdn.jsdelivr.net/npm/katex@0.13.18/dist/katex.min.css\n\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 `\u003cpre\u003e` 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://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffacelessuser%2Fmkdocs_pymdownx_material_extras","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffacelessuser%2Fmkdocs_pymdownx_material_extras","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffacelessuser%2Fmkdocs_pymdownx_material_extras/lists"}