我安装了MKDOC，创建了一个本地项目，然后将其上传到GitHub。然后，在读取过程中，我创建了一个链接到github repo设置为自动构建的项目。当我更改GitHub中的文件时，输出看起来如预期和更新。
现在，我对MKDOC的角色有些困惑。据我所知，我或其他任何想贡献的人都不再需要任何东西...我们只需要根据需要编辑/创建刻痕和图像文件，然后读取读者照顾其余的？我认为安装MKDOC的唯一原因是，我是否（或其他从事该项目的人）希望运行本地MKDOCS服务器，以查看在将其添加到GitHub之前，在将其添加到GitHub之前如何在本地渲染。这是正确的还是我错过了什么？
MKDOC显然不是问题...我只想知道发生了什么。
（安装
I installed MkDocs, created a local project, and uploaded it to GitHub. Then, in Read-the-Docs, I created a project linked to the Github repo set to auto build. The output looks as expected and updates as expected when I make changes to the files in Github.
Now, I am a bit confused about the role of MkDocs going forward. As far as I can tell, it is not really needed any more by either me or anyone else who wants to contribute...we just need to edit/create markdown and image files in the github repo as needed and Read-the-Docs takes care of the rest? The only reason I can think to have MkDocs installed is if I (or someone else working on the project) wants to run a local MkDocs server to see how edits get rendered locally before adding them to github. Is this right or am I missing something?
(Having MkDocs installed is clearly not a problem...I just want to know what is going on. Please be as patronizing as you like in your reply...I am a tech writer, not a developer :-) )
Thanks
发布评论
评论（1）
除非您想在本地构建项目的文档，否则无需在本地安装MKDOC。读取文档安装
.readthedocs.yamlconfig file中指定的所有依赖项（请参阅 https://docs.readthedocs.io/en/stable/config-file/v2.html#pypython ）。但是，即使没有配置文件指定依赖关系（例如MKDOC）来构建文档，读取文档也将安装一些强制性依赖项来构建您的文档（例如MKDOCS或SPHINX）。这就是为什么当协作者在GitHub上编辑文件时，没有本地安装的任何内容会在读取文档上正确反映更改的原因。
There is no need to have installed MkDocs locally unless you want to build your project's documentation locally. Read the Docs installs all the dependencies specified in the
.readthedocs.yamlconfig file (see https://docs.readthedocs.io/en/stable/config-file/v2.html#python).However, even if there is no config file specifying the dependencies (e.g. MkDocs) to build the documentation, Read the Docs will install some mandatory dependencies to build your documentation (e.g. MkDocs or Sphinx). This is why when a collaborator edits a file on GitHub, without anything installed locally, reflects the changes properly on Read the Docs.