标签: mkdocs

是否有在 Markdown 文件中使用 HTML 的解决方案 - 或显示一个纯 HTML 的整个额外页面的选项？

问题：我想在我的 mkdocs 生成的 wiki 中包含一个使用一些内联 Javascript 的 html 片段。

尝试过：我已经搜索了几个小时，但在此处或官方文档中找不到答案。

我正在使用Mkdocs生成文档,并希望使用firebase但使用身份验证.

我在firebase上托管了没有身份验证的html,但没有找到任何身份验证解决方案.

任何帮助表示赞赏.

我有一个用MkDocs制作的文档项目。我想在配置文件 ( mkdocs.yml) 中定义全局变量以在降价页面 ( *.md) 中使用。

阅读这个问题，似乎可以通过extra在mkdocs.yml文件中包含一个配置来完成，例如：

extra:
    version: 1.0

...然后，在页面中使用该变量，例如如下：

---> My version: {{ config.extra.version }}

我试过了，但不幸的是它在我的例子中不起作用（没有变量替代）：

• 难道我做错了什么？
• 有可能使这项工作吗？

我正在寻找一种在.md文件中自动包含目录的方法。这听起来像是一件微不足道的事情，并且在 GitBook 和其他静态网站生成器中已经存在很长时间了。

有什么扩展支持吗？

我不确定是否有可能解决这个问题 - 但无论如何我会问：

我正在开发一个 python 项目，使用 mkdocs 作为文档。
\n项目结构（简化）大致如下：

./\n|-- docs\n    |-- index.md\n    |-- page2.md\n    \xe2\x94\x94-- [other documentation stuff]\n|-- [the actual program stuff]\n|-- README.md\n\xe2\x94\x94-- mkdocs.yml\n

我正在使用 markdown_extensions markdown_include.include（在 mkdocs.yml 中声明），\n并且 index.md 仅包含{!README.md!}在此位置包含 markdown 文件的行。

这很好用，将 README.md 显示为文档的概述页面。

我现在遇到的问题是，在 README.md 中，我想有一个声明“有关更多详细信息，请参阅 XY”，其中 XY 应该是指向page2.md文档中标题的链接。

使用 mkdocs，我可以简单地编写see [here](page2.md#heading2)，并且在文档中完美运行。但是当我直接查看 README.md（例如在 github 上）时，结果是 404。

当我放置 时see [here](docs/page2.md/#heading2)，它在 README.md 中起作用，但在 mkdocs 创建的文档中不起作用。

有什么好的方法可以解决这个问题吗？非常感谢您的帮助！

我刚刚开始尝试 Docker，正在尝试解决他们的第一个教程。当我运行命令 docker 时，build -t docker101tutorial我收到一条错误消息ERROR [build 2/2] RUN mkdocs build。有谁知道如何解决这个问题或者以前曾经遇到过这个问题？

我从包含的ReadtheDocs主题切换到我的项目的bootswatch United主题.我做了pip install mkdocs-bootswatch这个主题,并改变了theme: readthedocs对theme: united我的mkdocs.yml文件.

但是,尽管该项目在阅读文档中成功构建,但文档仍保留标准的readthedocs主题.当我在本地(使用mkdocs serve)运行它时,它与United主题正确显示.

还有另一行代码我应该在某处调整吗？我应该添加一个需求文件？如何让外部主题正确地出现在ReadtheDocs ......或者甚至可以在readthedocs.org上使用外部主题？

注意:我确实问过MkDocs的人,他们说这是一个ReadTheDocs限制,所以如果有什么要做,似乎它将是一个与ReadTheDocs相关的解决方案.否则,我可能不得不切换到GitHub页面或类似的东西.

我如何在Travis CI中自动部署我的Mkdocs文档？

Github 上类似问题的解决方案都指向使用包管理器安装 MkDocs 或主题，而不是 pip。不过，我已经用 pip 安装了两者。

1. 使用 pip 安装 MkDocs（不是包管理器）
2. 使用 pip 安装了 n 个 MkDocs 主题
3. 更新了 mkdocs.yaml 添加：

theme:
   name: '{name_of_theme}'

4. 然后

mkdocs serve

5. 结果

ERROR   -  Config value: 'theme'. Error: Unrecognised theme name: '{name_of_theme}'. The available installed themes are: mkdocs, readthedocs 

我缺少什么？

我想将 HTML 文件嵌入到 MkDocs/Material 页面中。

我正在尝试类似下面的内容，但收到 404 错误。

知道正确的方法吗？

<div class="map">
  <iframe src="map.html"></iframe>
</div>

就其价值而言，这样的链接确实有效，但我希望选择将其嵌入到当前页面中。

[Show a map](map.html)