问题标签 [mkdocs]

所以我的设置如下：

• https://sub.domain.com/folder/部署在 Azure Blob 存储中的静态网站 (mkdocs) ，在 Kestrel 上运行。
• localhost:port在没有子域和文件夹的情况下进行本地测试。
• <link rel="manifest" type="application/manifest+json" href="manifest.json" crossorigin="use-credentials">并且文件/folder/处于已部署状态，在本地测试中处于根目录中。
• <script type="text/javascript" src="sw.js"></script>并且文件/folder/处于已部署状态，在本地测试中处于根目录中。
• 清单中的 start_url 是/folder/.
• 清单中的图标路径是，assets/icons/icon.png处于部署状态，在本地测试中处于根目录。assets/folder/

图标在本地工作，但在部署的站点上我得到：

Icon https://sub.domain.com/folder/assets/icons/icon.png failed to load

当我直接访问该 URL 时，文件加载得很好。

该网站落后于身份验证，但我crossorigin="use-credentials"在加载清单时使用。

完整清单.json：

我已经尝试过像./assets/icons/manifest-icon-512.png"以前一样的路径，但它也不起作用。

I am using mkdocs system which is configured using yaml file, parsed via PyYml. I want to be able to specificy environment variable in its mkdocs.yml which is not possible in mkdocs ecosystem, but workaround exists using PyYml special !!python/object/apply:os.getenv syntax which works great for yaml keys of type string.

However, this doesn't work:

The build complains that string is not bool value:

I looked into PyYAML section YAML tags and Python types^1 to no avail. I guess form:

!python/object/apply:module.f | value of f(...)

could be used as I need pythons distutils.util.strtobool( os.getenv("PDF_EXPORT_COMBINED") ) but not sure if that is possible using that syntax.

我正在使用 Mkdocs 来创建文章（一组静态 HTML 页面）。这些文档的问题在于 Mkdocs 创建的搜索系统非常基础，仅根据文章文本中的文章随机检索文章，并且不可能以任何方式进行连贯的短语匹配，没有“AB C”严格匹配搜索。

目前搜索效果如何糟糕的一些示例：
当您输入“不选择自动填充”时，搜索不会显示实际包含“默认情况下不选择“自动填充”这一短语的 3 篇文章，但而是调出所有包含 do、in、not、select、auto、fill + 它们的变体的文章。

当您在搜索字段中输入一个简短的词（例如“while”）时，不会检索到任何结果，即使该词出现在十几篇文章中也是如此。再比如：当你输入“选择器窗口”时，没有包含“时间选择器窗口”的文章被带到搜索结果的顶部；相反，检索所有包含单词“window”的文章。

请问有 Mkdocs-savvy 的人可以提供这方面的建议吗？

我的 Mkdocs.yml 中有什么：

{{{ ^ 由于某种原因，这个搜索标记器绝对被忽略了。如果它被删除，搜索会很糟糕:) }}}

我错过了什么？

我正在使用 MkDocs 和 Material 主题。我想建立一个看起来有点像 Stripe API 文档的网站。

默认情况下，Material 主题将 .md 文档放在左侧的侧边栏中，将带有这些文档的标题放在右侧的目录侧边栏中。我想把它全部放在左边：

我可以通过使每个条目成为自己的文档来做到这一点，但我更希望每个主要标题只有一个文档，目录由下面的子标题组成。可能的？

更新：

我已经取得了一些进展。

首先，按照以下说明扩展主题：https ://squidfunk.github.io/mkdocs-material/customization/

其次，通过覆盖“site_nav”模板块来摆脱右侧的目录。在 main.html 中，只需从 base.html 复制现有的 site_nav 块，然后注释掉“目录”部分。

第三，将 nav-item.html 部分复制到 /partials 目录并进行修改。

现在我被困住了。看起来 nav-item.html 确实有代码可以在每个项目下呈现 TOC，并且它确实使用 display:none 呈现。但是，当我关闭它时，TOC 没有正确显示。

我已经完成了一个小时的 CSS 摆弄，但没有成功。有任何想法吗？

您好，我使用 Typora 作为我的降价编辑器和 mkdocs 来构建文档项目。虽然我用 Markdown 语法将上标表示为

service_command ^字符串，必填^

它在 Typora 中显示完全正确。但是当我使用 mkdocs 构建项目时，基本的 html 不显示上标。我知道我们可以手动更改 html 代码以显示上标。但我正在寻找使 mkdocs 正确呈现上标的方法。我也尝试过使用标记来实现相同但 mkdocs 无法呈现上标。

这是 mkdocs 生成的示例 HTML 代码

这是 mkdocs 生成的 html 页面视图

以下是 Typora 显示预览的方式

我安装了一个主题，这样做之后，当我从命令行运行 mkdocs 命令时，我收到以下错误：

我在 mac 上运行：Python：2.7.15 PIP：20.0.2

任何有关如何解决此错误的建议将不胜感激。

我的mkdocs.yml文件的nav标题被缩短以适合左侧导航中的每行仅一行，并且我希望.mdMarkdown页面标题是未缩写的全长标题。

例如，虽然我的mkdocs.yml文件包含：

我希望.md页面标题为：

...而不是复制/使用mkdocs.yml导航标题：

当我将 Markdown 页面标题添加到文件的第一行 ( # Big Data...) 时.md，我得到了我想要的页面标题和继承的mkdocs.yml nav标题：

似乎答案是在mkdocs.yml文件中指定一个不同的/第二个“页面显示”名称，但许多谷歌搜索都没有出现。

您尝试或听说过哪些其他方法？谢谢！

更新！！！！

注意缩进！我的插件部分在我的代码编辑器中缩进，因此它作为包主题的一部分读取。现在我至少有一个插件可以工作了，我感觉有点清醒。现在开始调试另一个...

谢谢并留下这个，以防其他人犯同样的错误！

至于参考：

MKDocs 1.0.4 点 19.2.3 Python 3.8.1

很抱歉没有发布原始代码，因为这可能会有所帮助，因为我需要另一位同事开发人员注意到这一点。

原帖：

我不太确定断开连接发生在哪里，但我觉得我已经按照 MKDocs 的说明安装插件十次了，但仍然没有真正看到一些工作？在将其添加到配置文件之前，我已确保先安装所需的插件。

在我尝试其他任何方法之前，这是我目前正在努力的两个。

1：PDF导出插件

Pip 安装了似乎工作正常的那个。我已经在 mkdocs.yml 文件的插件部分下添加了 pdf-export 插件，并且我已经重建，使用 --clean 重建，并以各种组合保留，但是当它告诉我应该自动生成 PDF 文档时在构建命令中，我什么也没看到。

2. Git 修订日期

Pip 安装了似乎工作正常的那个。我已将 {{ git_revision_date }} 部分添加到我的 index.md 文件中，以查看它会生成什么。仅仅通过浏览器输出代码。

帮助？！

我需要在其他任何地方添加任何其他内容吗？我觉得我错过了一些东西，因为我的插件都没有向我显示任何响应。我一直在梳理 MKDocs 文档以及各个插件文档，但到目前为止还没有找到任何东西。

编辑：韦兰的回答成功了！谢谢！

我正在尝试压缩 .html 文档文件以发送给客户。目标是获得与浏览实际网站相同的体验。

打开 .html 文件时，单击的任何链接都会转到父文件夹，而不是特定的 .html。例如，如果我单击配置页面的链接，它会将我带到这个父文件夹（如图所示），其中包含指向实际页面的 index.html。这仅在我浏览 .html 文件时发生在我的本地实例中——而不是在我浏览构建的 .md（使用 MkDocs）时发生。

• macOS 卡塔利娜，10.15.3
• 文档
• 降价

@joki对上一个问题的回答表明，可以通过为可浏览的工件提供公共 URL 来将 GitLab 存储库中的每个活动分支部署到动态环境。

用mkdocs 材料项目尝试这个，我发现了两个问题。

首先，如果 GitLab 存储库位于组或子组中，则.gitlab-ci.yml文件中的 URL 需要更像这样：

其次，站点内的相关链接不能很好地工作，导致大量的 404 错误，以及样式文件等内容的丢失。可能上面的 URL 不正确，或者可能需要更改为site_url：mkdocs.yml

但是，这些都不适合我。

可以在此处找到具有非常小的部署和审查应用程序的最小 MR 。

有没有人有 mkdocs 审查应用程序的工作配方？