用于呈现图表文件的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的文件,其内容如下:

^{pr2}$

当MkDocs运行时(使用buildserve),这将导致创建一个名为event_processing.png的文件。 使用常规图像语法将其包含在降价文件中:![Event processing architecture](event_processing.png)

配置

此插件支持一些配置选项,可以设置如下:

plugins:-diagrams:file_extension:".diagrams.py"max_workers:5

file_extension

设置图表文件的文件扩展名。 当mkdocs buildmkdocs serve运行时,将执行以该扩展名结尾的所有文件。在

默认值:.diagrams.py

max_workers

worker池用于在多核系统上并行呈现图表文件。 设置此选项允许您将工作人员数量限制为此数量。在

默认值:动态选择(os.cpu_count() + 2

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

推荐PyPI第三方库


热门话题
java Selenium Facebook安全检查的验证码不可见   java后台线程在设置EditText的值时失败   java从文本文件读取阿拉伯文字符   使用自定义java程序上载已编译的命令c程序   java字符串是可变的,但代码没有显示这一点   java Jtable保留列宽   java无法使用servlet和jsp更新表中的特定记录   java反向编码字符串   在java中使用socket填充html表单   引发junit意外的Java断言错误:重新实例化静态对象后应为null   从表中删除列之前要考虑的java因素   java PMD选项在Spring工具套件3.9.6中不可见   java Google+4.3及以上版本无法访问“/storage/emulated/legacy/”,以从中裁剪图像   在Java中打印连接字符串时出现问题   哪一个java http客户端库易于用于以编程方式发布、设置Cookie和ajax?