代码之家  ›  专栏  ›  技术社区  ›  Kim Stacks

如何在macosx上测试github repo mkdocs本地构建的文件?

mkdocs read-the-docs
  •  0
  • Kim Stacks  · 技术社区  · 7 年前

    make changes to its docs . 它使用readthedocs作为主题的宿主和mkdocs。

    我用的是macOS Mojave。

    https://docs.readthedocs.io/en/latest/install.html 安装指南 readthedocs mkdocs.yml

    那么,当我对文件进行更改时,如何测试readthedocs的构建文件呢 在macOS X本地?

    如果有必要的话,我不介意用docker。

    1 回复  |  直到 7 年前
        1
  •  0
  •   Kim Stacks    7 年前

    我对这个问题的思维模式是错误的。ReadTheDocs只是一个使用文档生成器(sphinx或mkdocs)并承载生成的输出文件的服务。

    1. 分岔回购
    2. 本地克隆fork
    3. 设置合适的虚拟环境(因为textX是python库,mkdocs也是)
    4. 安装中所述的适当的所需库 requirements.txt requirements_dev.txt 取决于回购协议
    5. 运行 mkdocs serve

    127.0.0.1:8000 供您测试生成的html文件。要更改mkdocs配置,请转到 mkdocs.yml

    推荐文章
    关于   移动版
    代码之家 - 一站式码农服务社区
    沪ICP备11025650号