Skip to main content

MkDocs 插件来呈现其他格式文件。

项目描述

PyPI - Python 版本 派皮 PyPI - 下载 GitHub 贡献者 PyPI - 许可证

mkdocs-render-otherfile-plugin

MkDocs插件,用于在 mkdocs 构建中呈现其他格式文件。这只会影响您呈现的 HTML,不会影响降价文件。

设置

使用 pip3 安装插件:

pip3 install mkdocs-render-otherfile-plugin

接下来,将以下行添加到您的mkdocs.yml:

plugins:
  - search
  - render-otherfile

如果您的配置文件中还没有plugins条目,您可能还想添加search插件。如果没有plugins设置条目,MkDocs 默认启用它。

用法

文件中设置的多个选项的示例mkdocs.yml

plugins:
    - search
    - render-otherfile
        ext:
            - .c
            - .cpp
            - .py

选项

  • ext: 文件 ext 在 mkdocs 构建过程中呈现。

项目详情


下载文件

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

源分布

mkdocs-render-otherfile-plugin-1.0.0.tar.gz (2.9 kB 查看哈希

已上传 source

内置分布

mkdocs_render_otherfile_plugin-1.0.0-py2.py3-none-any.whl (4.5 kB 查看哈希

已上传 py2 py3