问题标签 [mkdocs]

我第一次使用Read the Docs。我正在为命令行系统编写文档，我的“代码示例”包括 shell 输出日志。shell 输出最终看起来像这样

那就是——服务（或我对它的使用？）正在尝试格式化这个运行 shell 命令的示例，就好像它是源代码一样，并且将它magento2:generate视为一个类常量。

我可以控制哪些代码块在阅读文档时获取源代码格式吗？我尝试在管理员中不设置基本语言，但似乎没有效果。或者这是我需要在狮身人面像级别的 mkdocs 上控制的东西？（通过将您的 markdown 或 sphinx 文件转换为漂亮的 HTML 文件来阅读文档）或者其他什么？还是我运气不好？

我编写了一些自定义 CSS，我希望将其包含在 ReadTheDocs 托管的 Mkdocs 站点中。它不起作用，因为 RTD 不提供 CSS 文件。

我有一个.readthedocs.yml要求 RTD 使用 Mkdocs 的文件：

我的.mkdocs.yml文件引用了我使用自定义 CSS 文件的事实：

ReadTheDocs 报告说文档构建良好，但是当我加载它们时，自定义 CSS 不起作用。如果我打开浏览器控制台，我会看到此错误：

拒绝应用来自“ https://private-site.readthedocs-hosted.com/en/latest/.mkdocs.material.css ”的样式，因为它的 MIME 类型（“text/html”）不是受支持的样式表 MIME 类型，并启用严格的 MIME 检查。

如果我在其自己的选项卡中打开 CSS 文件 URL，我会看到“404 - 未找到”页面。

.readthedocs.yml我尝试在根目录（where和.mkdocs.ymllive）和我的 docs 目录（ ）中包含 CSS 文件my-docs-directory，但都不起作用。

我想我需要 RTD 以某种方式知道将 CSS 文件作为静态文件提供，但我能找到的所有关于这方面的指南都是特定于 Sphinx 的。

请帮忙！谢谢！

我正在尝试在自定义主题中添加一些 html 元素（如 div），这些元素将 mkdocs 从 html 输出中生成的代码块包装起来。

mkdocs 的代码块带有三个反引号 ``` stuff ```，当它生成 html 输出时，它会创建<pre><code (some stuff here)> stuff </pre></code>. 我想知道是否有一种自定义主题的方法可以保留带有highlight.jsclass 属性的 pre 和 code 标记输出，但也允许我将其包装在自定义中div，以便我可以将代码块与其他一些元素一起放入容器中。

我正在寻找一种在.md文件中自动包含 TOC 的方法。这听起来很简单，并且在 GitBook 和其他静态网站生成器中使用了很长时间。

是否有任何扩展支持它？

我正在为我在 mkdocs 中的一个项目创建一个指令列表，我相信它使用 python-markdown 作为它的降价引擎。但是当我尝试在列表中的数字之间放置一个围栏代码块时，它会导致编号错误。

一个让我失望的例子（我还尝试在每个反引号围栏和实际单词之间添加换行符，但它仍然会弄乱编号）：

呈现如下内容：

然后，当我尝试缩进它时，它只会弄乱渲染：

至

是的，选项卡有效，但如果我想用 ```language. 有没有办法保留围栏代码块，但也维护列表编号。

我想自动生成一个文档站点，其中包含我项目中所有存储库的自述文件。我对 GitHub 有点陌生，所以我不确定我的术语是否正确。我提供了包含所有存储库的 GitHub 页面的链接。

https://github.com/casework

我想知道是否有任何方法可以让网站自动为在任何存储库中找到的所有自述文件生成文档。理想情况下，这将是一个能够识别自述文件是否被编辑或是否创建了新存储库的网站，然后自动更新该网站的文档。

我一直在查看 mkdocs 和 Sphinx，但我想知道是否有一种简单的方法可以根据这些存储库中的自述文件自动生成和更新文档。据我所知，这些工具不会自动更新网站。

我一直在尝试通过添加气流插件来扩展气流的 UI。我的目标是能够从气流中显示内部项目文档。我为此使用 MKDocs。

我遵循了气流文档流程（https://airflow.apache.org/plugins.html#example）并成功创建了一个插件。该链接出现，当我单击它时，它会将我带到 index.html。我的问题是它没有渲染任何 CSS、图像和其他 .md 或 .html 文件。它们都在同一个文件夹中。

我在 StackOverflow 上找到了一个类似的线程（Airlfow serving static html directory）。我试图遵循那里发布的解决方案，但它没有帮助。

我还在气流帮助论坛上发布了查询，但我还没有收到任何解决方案。我会很感激任何线索。谢谢你。

插件类：

我想在我的降价文件中有链接，而不需要指定文本链接，比如我们：

有没有办法在不复制 URL 的情况下这样做？

由于 URL 可能会随着时间而改变，我想避免必须更改它们两次。

（分享问题，因为我花了一段时间才找到答案）

概述：

我正在使用GitHub Pages功能来托管文档。我正在开发一个 CI/CD 流程来自动化构建，以便在更新文档源时，它会自动重新构建内容并部署到 GitHub Pages。

细节：

到目前为止，使用AWS CodeBuild，我已经实现了以下内容：

1. 从 GitHub Repo 拉取源代码
2. 使用MkDocs构建并使用“ mkdocs gh-deploy ”命令部署到特殊的 gh-pages 分支。

这是通过 CodeBuild 构建规范中的命令行完成的。我使用命令的原因是我想使用GitHub 部署密钥，而不是创建我的团队需要管理的用户帐户（用作机器帐户）。

除了触发构建的内容外，我一切正常。如果该过程使用用户帐户进行身份验证，那么我可以使用AWS CodePipeline在 GitHub 存储库中创建一个Webhook，然后通过 Webhook 发送通知以告知主分支已更新，这将触发新的构建。

我想实现一个类似的过程，但使用 GitHub 存储库的部署密钥。有什么建议么？

我们正在使用mkdocks并且我们想要更改在您使用 Mk-docs 时开箱即用的默认图标（教育），我们已经创建了.png带有图标的文件并将其添加到 GitHub 存储库，但是当您提供指向它的链接时你什么都看不到

我尝试

还有直接链接

https://github.com/NVM/my-tool/blob/master/logo.png

但是，我能够将它直接链接到自述文件（查看它是否有效）

我也尝试过提供相对链接（我的项目结构是）

并更改参考

哪个也没用……</p>

如果我从https://material.io/resources/icons/?icon=sports_cricket&style=baseline将其更改为其他内容

有用

知道我在这里想念什么吗？不支持png吗？

如果有一些参考如何使用自定义图标来做到这一点，它将对我有很大帮助，因为我现在被阻止了:(

这是我们要更改的默认徽标

更新

我能够添加favicon哪些适用于.png并添加.svg图标，但并将其引用到徽标条目但仍然不起作用......任何想法？