2

我在文档上读到只有很少的插件被预装在构建发生的 virtualenv 中。那么如何使用带有自定义插件的阅读文档服务呢?

mkdocs用来构建一些文档,在mkdocs.yml配置文件中我添加了以下扩展:

markdown_extensions:
    - smarty

    - admonition

    #https://pythonhosted.org/Markdown/extensions/abbreviations.html
    - abbr

    #https://pythonhosted.org/Markdown/extensions/definition_lists.html
    - def_list

    #https://pythonhosted.org/Markdown/extensions/footnotes.html
    - footnotes

    #https://facelessuser.github.io/pymdown-extensions/
    - pymdownx.emoji:
        emoji_generator: !!python/name:pymdownx.emoji.to_png

    - pymdownx.details
    - pymdownx.superfences
    - pymdownx.caret
    - pymdownx.mark

在本地环境中,提供的预览mkdocs serve工作正常,当部署以读取文档(通过连接的 github 存储库)时,构建失败,因为它找不到pymdownx插件,但我认为 RTD 会自动获取它们构建环境中存在的默认插件。

4

1 回答 1

0

AFAIK,阅读文档 (RTD) 不支持使用第三方扩展。事实上,RTD 只支持 MkDocs 0.14 版本。然而,MkDocs 已经发布了多个附加版本(目前最高 0.16),每个版本都修复了多个错误并添加了各种功能。

RTD 在 MkDocs 的主机中是独一无二的。对于所有其他主机,您需要先在本地构建站点,然后再推送到主机。这使您可以确保拥有适合您构建的环境。但是,RTD 在服务器上构建站点,这意味着您被他们的环境困住了,这可能符合您的需求,也可能不符合您的需求。

于 2017-09-15T13:48:26.880 回答