Python降价扩展包。

mkdocs-material-extensions的Python项目详细描述


Donate via PayPalBuildCoverage StatusPyPI VersionPyPI - Python VersionLicense

MkDocs材料扩展

MkDocs for Material的降价扩展资源

安装

pip install mkdocs-material-extensions

内嵌SVG图标

MkDocs Material提供了Material、FontAwesome和Octicons中的许多图标,但它是通过内联SVG来实现的 源代码中的图标。目前还没有一种简单的方法可以访问这些图标并任意地将它们插入Markdown中 内容。用户必须包括图标字体本身,并用HTML来做。在

此模块允许您使用PyMdown扩展Emoji扩展来轻松插入MkDocs材料的 SVG资产使用简单的:emoji-syntax:。这是通过创建我们自己的emoji indexemoji generator。自定义索引提供了Emoji扩展Twemoji的修改版本 索引。在

除了自定义索引外,还必须指定关联的自定义生成器。这会发现 适当的图标,并将其作为内联SVG插入到您的Markdown内容中。在

示例:

^{pr2}$

然后,使用Material的.icons文件夹的文件夹结构,可以指定图标:

We can use Material Icons :material-airplane:.

We can also use Fontawesome Icons :fontawesome-solid-ambulance:.

That's not all, we can also use Octicons :octicons-octoface:.

使用本地自定义图标

在MkDocs中,您可以本地覆盖主题资源,甚至可以向主题添加资源。不幸的是,降价解析 进程不知道MkDocs环境。幸运的是,如果您使用的是PyMdown Extensions 7.1,那么可以传入custom 构建表情符号索引并包含自定义SVG资产时将使用的图标路径。如果文件夹路径 theme/my_icons被赋予索引生成器,my_project/my_icons下的所有图标,即使在子文件夹中,也会 成为索引的一部分。在

markdown_extensions:-pymdownx.emoji:emoji_index:!!python/name:materialx.emoji.twemojiemoji_generator:!!python/name:materialx.emoji.to_svgoptions:custom_icons:-theme/my_icons

如果在my_project/my_icons/animals/bird.svg处给定一个图标,则可以使用emoji语法 :animals-bird:。请注意,所提供的基本文件夹并不影响图标的名称。还有,文件夹 用-分隔。文件夹名和图标名应该与emoji语法兼容,所以特殊字符 应该避免---和{}都可以。在

您可以提供任意多个路径,并且将按照指定的顺序对它们进行求值。这个 材质主题自己的图标将在所有自定义路径后进行评估。这允许用户在下列情况下覆盖材质的图标: 渴望的。在

如果索引中已经有图标名称,则不会添加该图标。建议始终在 子文件夹以帮助它们命名以避免名称冲突。在上面的例子中,bird位于animals之下,其中 创建了名称:animals-bird:,并帮助创建了一个更独特的名称,同时减少了创建重复的机会 使用现有的表情符号和材质图标命名。在

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java静态键入和编写一个简单的矩阵库   java如何最小化层次结构的代码量   这是在Google云数据存储中使用Java按键查询的正确方法吗?   java Android php+mysql+json执行异步任务时出错   java Hadoop Hbase访问被拒绝异常   java如何在json中指定特定的对象路径   JavaSpringJPA/Hibernate在使用@modify和@Query进行特殊更新之前调用完整更新   java多个错误通知   java插入Linkedlist和Node   java将图像放在webview中并调整其宽度   Java没有真实属性的缺点是什么?   java“isGooglePlayServicesAvailable”(此)已被弃用   java托管HIPPO CMS   安卓 Java。网URI构造函数不是编码字符(&C)   java如何用hibernate映射Deque?   java传递枚举类型作为参数   java自由堆大小在Maven中不会增加   java如何使用hashmap和arraylist的循环逻辑?   java如何使用JDBC复制MySql数据库