问题标签 [mkdocs]

我正在使用 mkdocs 从 Markdown 构建 hendrix 文档。

当显示在readthedocs上时，文档没有标题的锚链接。

如何在 github 上使用 mkdocs？

我有一个从主存储库克隆的存储库。这种情况下，我如何推送文档（我在 Windows 上使用 Git）。

我倾向于用 Markdown 编写我的 API 文档，并使用 MkDocs 生成一个静态站点。但是，我想托管文档的站点是 Django 站点。所以我的问题是，我似乎无法通过谷歌搜索找到答案，我将如何在某个位置托管 MkDocs 静态生成的站点文件/api/v1/docs并在该 URL 上查看静态站点？

更新： 我应该指出我确实在 Apache 下提供所有静态文件，并且不使用 runserver 或调试模式来提供静态文件，这太疯狂了。该站点是完全构建的，并且与 REST API 一起工作。

我的问题只是我如何让 Django（或者我应该说 Apache）在某个 URL 下为 MkDocs 生成的静态站点（对于我的 API 文档）提供服务。我了解如何为网站提供媒体和静态文件，但不一定了解如何提供 MkDocs 生成的内容。它会生成一个完全静态的“站点”目录，其中包含 HTML 和资产文件。

I'm following the mkdocs setup process here: http://www.mkdocs.org/#installation

I'm not able to get mkdocs to do anything past the install on my local machine. I've installed the latest python and pip. I've verified the mkdocs package is installed, but still nothing:

Are there additional steps needed to get mkdocs running on OSX?

至少它显然很受欢迎，但是 mkdocs 目录中的“主”文件必须称为 index.md 吗？如果我在其他地方的文件夹中引用文档，即不属于该文件的层次结构，该怎么办？我问，因为我对其他地方链接的文件有一个小问题。我在网上找到的关于此的文档很少（如果有的话）。谢谢

我可以以某种方式将文件包含到 mkdocs 中的文件中吗？我不想一次又一次地复制粘贴相同的部分。谢谢

请大家帮帮我！

我在 nginx 和 gunicorn 中使用我现有的 python 项目部署 MkDocs 有一个问题。

问题是：

If I use python run.py it's working fine, but I use supervisor gunicorn it's not work.

Python脚本：

请问有什么帮助吗？

有没有办法在 Mkdocs 或 Sphinx 中创建如下标签式代码块？

我从包含的 ReadtheDocs 主题切换到我的项目的 bootswatch United 主题。我pip install mkdocs-bootswatch为这个主题做了一个，并在我的文件中更改theme: readthedocs为。theme: unitedmkdocs.yml

然而，尽管项目在 Read the Docs 中构建成功，但文档保留了标准的 readthedocs 主题。当我在本地运行它（使用mkdocs serve）时，它以 United 主题正确显示。

我应该在某处调整另一行代码吗？我应该添加一个需求文件？我怎样才能让外部主题正确出现在 ReadtheDocs 中......或者实际上，我什至可以在 readthedocs.org 上使用外部主题吗？

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

我正在使用 Mkdocs 生成文档，并希望使用 firebase 但使用 Authentication进行托管。

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

任何帮助表示赞赏。