核心MkDocs插件被后台的TechDocs用作多个MkDocs插件和Python Markdown扩展的包装器
mkdocs-techdocs-core的Python项目详细描述
mkdocs技术文档核心
这是将Mkdocs与Spotify的TechDocs一起使用时使用的基本Mkdocs插件。它是用Python编写的，并将Mkdocs的所有默认值打包到一个插件中，比如主题化、插件等。在
使用
$ pip install mkdocs-techdocs-core
一旦安装了mkdocs-techdocs-core插件，就需要将其添加到mkdocs.yml中。在
在本地运行
您可以使用pip和用于制作开发Python包的--editable标志在本地安装此包。在
pip install --editable .
{{cd5}文件夹中的{docs}必须指向这个文件包。在
与Docker一起跑步
在父级Dockerfile中，我们将此文件夹添加到构建中，并在容器中本地安装包。将来，我们可能会放弃这种方法，直接从Python注册中心下载（这个文件夹将发布到一个）。在
有关如何构建和运行Docker容器的详细信息，请参见位于techdocs-container/文件夹中的README.md。在
剥落
pip install -r requirements.txt python -m black src/
注意：这将用格式化的代码写入src/中的所有Python文件。如果只想检查它是否通过，只需附加--check标志。在
MkDocs插件和扩展
TechDocs核心MkDocs插件附带了一组MkDocs支持的扩展和插件。下面您可以找到包含在 TechDocs核心插件：
插件：
扩展名：
- admonition
- toc
- pymdown
- 插入符号
- 评论家
- 细节
- 表情符号
- 超自然
- 内斜长石
- 马奇林克
- 马克
- smartsymobls公司
- 突出显示
- 额外的
- 有标签的
- 任务列表
- 颚化符
- markdown_inline_graphviz
- plantuml_markdown
变更日志
0.0.13
- 修正了整个temp目录可以包含在构建站点输出中的问题。#7
0.0.12
0.0.11
- 来自的任何MkDocs插件配置mkdocs.yml公司现在可以工作并覆盖默认配置。见https://github.com/backstage/backstage/issues/3017
0.0.10
- 固定降价版本以修复Graphviz的问题
0.0.9
- 将开发状态更改为3-Alpha
0.0.8
- Superfences和codeilite不能很好地一起工作（squidfunk/mkdocs material#1604），因此codeilite扩展被替换为pymdownx.highlight在
- 使用pymdownx extensions v.7.1而不是8.0.0来允许旧版的\u tab_classes config。这使得techdocs核心插件与使用标签页进行分组降价兼容，语法如下：
```java tab="java 2"
public void function() {
....
}
```
以及新的
=== "Java"
```java
public void function() {
....
}
```
pymdownx扩展在不久的将来也将被升级为8.0.0。在
- 在
在pymdownx.tabbed添加到支持选项卡以对标记内容（如代码块）进行分组。在
在 - 在
“PyMdown扩展包括三个扩展，它们将替换默认Python Markdown扩展中的对应扩展。”因此，在这个版本中，一些扩展被删除了，默认情况下pymdownx.extra现在添加（https://facelessuser.github.io/pymdown-extensions/usage_notes/#incompatible-extensions）
在
0.0.7
- 修复emoji支持的配置问题
0.0.6
- 进一步调整版本以找到兼容的版本
0.0.5
- 将降价扩展的某些版本降级为更稳定的版本
0.0.4
- 增加了对更多mkdocs扩展的支持
- mkdocs材料
- mkdocs monorepo插件
- plantuml降价
- 降价内联graphviz扩展
- pygments公司
- pymdown扩展
- 项目
标签：
欢迎加入QQ群-->： 979659372
