跳转到主要内容

MkDocs插件,用于在构建过程中程序化生成文档页面

项目描述

mkdocs-gen-files

插件MkDocs 在构建过程中程序化生成文档页面

PyPI GitHub GitHub Workflow Status

pip install mkdocs-gen-files

继续到文档网站

使用方法

mkdocs.yml 中激活插件(scripts 是必须执行的Python脚本列表,始终相对于 mkdocs.yml

plugins:
  - search
  - gen-files:
      scripts:
        - gen_pages.py  # or any other name or path

然后创建这样的脚本 gen_pages.py(这是相对于根目录,不是相对于 docs 目录)。

import mkdocs_gen_files

with mkdocs_gen_files.open("foo.md", "w") as f:
    print("Hello, world!", file=f)

这将在我们的网站上添加一个通过程序生成的页面。也就是说,文档实际上并不出现在我们的源文件中,它只是虚拟地成为MkDocs构建的网站的一部分。

继续到文档网站

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源代码分发

mkdocs_gen_files-0.5.0.tar.gz (7.5 kB 查看散列值)

上传时间 源代码

构建分发

mkdocs_gen_files-0.5.0-py3-none-any.whl (8.4 kB 查看散列值)

上传时间 Python 3

支持

AWSAWS云计算和安全赞助商DatadogDatadog监控FastlyFastlyCDNGoogleGoogle下载分析MicrosoftMicrosoftPSF赞助商PingdomPingdom监控SentrySentry错误日志StatusPageStatusPage状态页面