文档改进,来自新手的观察

Hi, 让我开始并感谢您的项目! 从某种程度上来看,它确实工作得很好,尽管它给我带来了一些麻烦/问题。我想与您分享我的观察,供您考虑并可能改进您的文档,因为我目前经历了您的文档就像一个完全的新手。您将阅读的一切可能会让我显得愚蠢,但新手的确是愚蠢的,至少在理解事情如何运作的方式上。 我使用的是 Windows,我的用例是导出 Obsidian MD markdown 文件,这些文件将保存我个人的文档,涉及设置和配置软件(现在包括 McDocs)、编码片段和一般提示,我希望在 GitHub 上发布这些内容。 因此,我设置了一个工具链来导出这些 Obsidian markdown 文件,经过一些努力甚至扩展了 Obsidian 模块,我就能将所有文件导出到一个本地目录。这就是 McDocs 发挥作用的地方。 我的目标是能够在本地生成静态网站,查看和修正它,然后将其推送/发布到 GitHub。 我最终获得了 mkdocs 的"入门页面"。 我决定使用"readthedocs"作为主题。 安装过程顺利,第一个示例也正常运行。 我导出了我的 markdown 文件并启动了 mkdocs serve。 我能够在本地主机上浏览我的网站。 很好 ... 除非出现 404 错误和无法显示我的第一页。 我重新阅读了文档,确保我的 Index.md 文件位于正确的文件夹中。 没有任何东西起作用。 我学会了如何推送到 gh-pages,我学会了如何设置一个动作工作流程。 没有任何东西帮助。 您可能已经注意到我做错了什么了吗? 1) 请! 在"入门"的第一页中插入一句,表明您的 index.md 文件必须以小写字母"i"开头! 您的示例当然可以正常运行,但这个细节让我感到非常烦恼。 2) 在 GitHub 页面和目录深度一直是第二个障碍。 我相当长时间都没有意识到我需要使用 site_url: 和我需要将其与 GitHub PAGES URL 结合使用。 回头看,这很明显,但一句说明如何找到该 URL 或是它与您可以从主分支站点复制的链接不同,该链接是克隆仓库的 URL 也会很有帮助。 3) 一个(简短的)分步指南和更详细的示例,说明如何设置 GitHub/您的本地 git 目录以及如何推送到 gh-pages 将非常棒! 4) Readthedocs 文本 - 一个小错误,我还没有检查(好吧,我没有检查哪些是正确的): "Readthedocs" Readthedocs 服务使用的默认主题的克隆,它提供与其父主题相同的受限功能。与其父主题一样,只支持 **两级** 的导航树。 navigation_depth: 导航树在侧边栏的最大深度。 默认值: 4。 5) Readthedocs(标准?)主题似乎不提供通过按钮复制/粘贴代码的功能 - 因此,与其父主题相比,mkfdocs 版本似乎不像它的父主题。 --> 但我知道这可能是我还没有注意到的事情 - 仍在尝试