用于呈现图表文件的MkDocs插件
mkdocs-diagrams的Python项目详细描述
mkdocs图表
一个用于MkDocs文档站点生成器的插件,它有助于通过Diagrams项目(view examples)轻松嵌入系统架构图。在
安装
mkdocs-diagrams
在PyPI上可用。
它可以通过pip install mkdocs-diagrams
或带有pipenv或poetry的等效命令进行安装。在
您还需要在系统上安装graphvizdot
工具。
在大多数包管理器中,它以graphviz
的形式提供。在
安装后,通过将diagrams
包含在mkdocs.yml
中的plugins
列表中,配置MkDocs以使用此插件。
例如:
plugins:-diagrams-search
(如果您的配置中还没有plugins
键,那么您几乎肯定也希望包括search
。
它是一个默认的插件,否则会被停用。)
使用
Warning: This plugin will execute
.diagram.py
files during build, as that is how Diagrams itself operates. Be careful using this plugin with untrusted input as this effectively allows arbitrary code execution.
安装后,可以通过在docs目录中包含diagrams文件来使用diagrams插件。在
例如,创建一个名为example.diagrams.py
的文件,其内容如下:
当MkDocs运行时(使用build
或serve
),这将导致创建一个名为event_processing.png
的文件。
使用常规图像语法将其包含在降价文件中:![Event processing architecture](event_processing.png)
配置
此插件支持一些配置选项,可以设置如下:
plugins:-diagrams:file_extension:".diagrams.py"max_workers:5
file_extension
设置图表文件的文件扩展名。
当mkdocs build
或mkdocs serve
运行时,将执行以该扩展名结尾的所有文件。在
默认值:.diagrams.py
max_workers
worker池用于在多核系统上并行呈现图表文件。 设置此选项允许您将工作人员数量限制为此数量。在
默认值:动态选择(os.cpu_count() + 2
)
- 项目
标签: