扩展MkDocs Material主题的插件。

导航

已验证详情

这些详情已由PyPI验证
维护者
来自gravatar.com的facelessuser头像 facelessuser

未验证详情

这些详情尚未由PyPI验证
项目链接
元数据
  • 许可证： MIT许可证
  • 作者： Isaac Muse
  • 标签 扩展, markdown
  • 需求： Python >=3.8
分类

项目描述

MkDocs Pymdownx Material Extras

MkDocs的插件 -- 专门针对MkDocs Material主题。

添加了PyMdown Extensions文档和其他@facelessuser项目使用的额外资源。

虽然这并非专为外部消费而设计，最初是为@facelessuser项目编写的，但如果需要，可以自由使用。

文件是从pymdown-extensions项目中复制的。

说明

此插件绑定到MkDocs Material和PyMdown Extensions的特定版本。它有时可能与测试版本相关。

安装

pip install mkdocs_pymdownx_material_extras

将其添加到您的mkdocs.yml插件中。假设您正在使用MkDocs Material。这样做时，请记住添加回search插件，因为它不会追加到插件中，而是覆盖插件

plugins:
  - search
  - mkdocs_pymdownx_material_extras

按以下方式设置您的主题

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

以下材料主色/强调色与实际Dracula颜色相对应

材料 Dracula
红色 红色
粉色 粉色
紫色 紫色
深紫色 紫色
蓝色 蓝色
靛青色 蓝色
浅蓝色 蓝色
青色 青色
蓝绿色 青色
绿色 绿色
浅绿色 绿色
黄绿色 绿色
黄色 黄色
琥珀色 黄色
橙色 橙色
深橙色 橙色

赞助商页脚链接

如果您想在页脚添加赞助商的心形图标，请像这样在MkDocs主题选项下添加您的赞助链接。

theme:
  pymdownx:
    sponsor: "https://github.com/sponsors/facelessuser"

Mermaid 支持

Mermaid 支持已经集成。只需将 Mermaid 脚本添加到您的 MkDocs 配置中即可。

extra_javascript:
  - https://unpkg.com/mermaid@8.8.4/dist/mermaid.min.js

如果您不喜欢我们的默认设置，您可以自由修改它。只需在包含 Mermaid 之前提供一个脚本文件即可。

extra_javascript:
  - my_mermaid_config.js
  - https://unpkg.com/mermaid@8.8.4/dist/mermaid.min.js

此外，设置您的 Mermaid 图表

markdown_extensions:
  - pymdownx.superfences:
      custom_fences:
        # Mermaid diagrams
        - name: diagram
          class: diagram
          format: !!python/name:pymdownx.superfences.fence_code_format

然后您可以在 diagram 代码块中指定您的 Mermaid 图表

```diagram
...
```

每个方案都提供 Mermaid 设置。如果您尝试覆盖它们，您可以在这里查看设置 here。

MathJax/KaTeX

同样，MathJax 和 KaTeX 支持已经集成。只需将 MathJax 脚本添加到您的 MkDocs 配置中即可。

MathJax

extra_javascript:
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net.cn/npm/mathjax@3/es5/tex-mml-chtml.js

KaTeX

extra_javascript:
  - https://cdn.jsdelivr.net.cn/npm/katex@0.13.18/dist/katex.min.js

最后，设置 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

如果您不喜欢默认的 MathJax 设置，请在 MathJax 脚本之前添加您自己的配置。

extra_javascript:
  - my_mathjax_config.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net.cn/npm/mathjax@3/es5/tex-mml-chtml.js

项目详情

已验证详情

这些详情已由PyPI验证
维护者
来自gravatar.com的facelessuser头像 facelessuser

未验证详情

这些详情尚未由PyPI验证
项目链接
元数据
  • 许可证： MIT许可证
  • 作者： Isaac Muse
  • 标签 扩展, markdown
  • 需求： Python >=3.8
分类

发布历史 发布通知 | RSS 源

此版本

2.6

2.5.6

2.5.5

2.5.4

2.5.3

2.5.2

2.5.1

2.5

2.4.3

2.4.2

2.4.1

2.4

2.3.1

2.3

2.2.1

2.2

2.1

2.0.3

2.0.2

2.0.1

2.0

1.6

1.5.7

1.5.6

1.5.5

1.5.4

1.5.3

1.5.2

1.5.1

1.5

1.4

1.3

1.2.2

1.2.1

1.2

1.1.3

1.1.2

1.1.1

1.1

1.0.10

1.0.9

1.0.8

1.0.7

1.0.6

1.0.5

1.0.4

1.0.3

1.0.2

1.0.1

1.0

1.0b11 预发布

1.0b10 预发布

1.0b9 预发布

1.0b8 预发布

1.0b7 预发布

1.0b6 预发布

1.0b5 预发布

1.0b4 预发布

1.0b3 预发布

1.0b2 预发布

1.0b1 预发布

下载文件

下载适用于您平台的应用程序。如果您不确定要选择哪个，请了解有关 安装软件包 的更多信息。

源代码分发

mkdocs_pymdownx_material_extras-2.6.tar.gz (25.4 kB 查看散列值)

上传时间 源

构建分发

mkdocs_pymdownx_material_extras-2.6-py3-none-any.whl (27.7 kB 查看散列值)

上传于 Python 3

由以下支持