问题标签 [mkdocs]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
334 浏览

python - 在 mkdocs 中添加自定义元数据

有没有办法在页面中放置自定义元标记?我试着像文档说的那样添加它,但只有标准标签被解析为元数据。自定义标签被忽略。

0 投票
1 回答
7460 浏览

javascript - 将脚本标签添加到降价文件

我正在 MKdocs 中开发文档,需要将一些脚本文件加载到我的 markdown 文件中。如何在markdown中添加js函数和脚本标签?

0 投票
0 回答
225 浏览

mkdocs - 将徽标添加到 mkdocs 文档

我需要自定义 MKdocs 导航标题和搜索部分。我该如何定制呢?我知道在 custom_theme 目录下我们必须放置自定义文件。但是在这里我不知道自定义导航标题和搜索部分的文件名是什么。这个你能帮我吗。

0 投票
2 回答
1173 浏览

mkdocs - 错误 - 配置值:“主题”。错误:无法识别的主题名称:

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

  1. 使用 pip 安装 MkDocs(不是包管理器)
  2. 使用 pip 安装了 n 个 MkDocs 主题
  3. 更新 mkdocs.yaml 以添加:
  1. 然后
  1. 结果

我错过了什么?

0 投票
1 回答
246 浏览

python - Travis CI 仅从构建脚本上传空文件

我目前正在尝试在 Travis CI 上建立一个文档项目。构建脚本使用 mkdocs 库将 markdown 文件生成为 HTML 文件。我已经尝试了好几个小时来使用 Travis CI 自动化部署过程。它应该直接在 Travis CI 上生成文件并将其上传到 FTP 服务器。

我试过的

所以我已经将这个 .travis.yml 文件提交到我的 Github 存储库。

mkdocs 构建脚本会在根文件夹“documentation”中输出生成的文件。实际上,除非 FTP 服务器上的目录不存在,否则此代码有效。

什么不起作用

我在本地尝试了相同的代码(只是运行了 after_success 命令),它在那里正确地上传了包含内容的文件。当 Travis-CI 现在开始将文件上传到我的 FTP 服务器时,它会开始传输,但直到抛出超时异常才会结束。当我检查服务器上的文件时,它只创建了空文件。

也许有人可以帮助我为什么会出现这个问题?

0 投票
1 回答
978 浏览

favicon - 如何为 mkdocs 网站添加 favicon?

我正在开发 mkdocs 网站。在这里,我需要为我的网站添加 favicon。我试过这样,但它不工作。

我在 mkdocs.yaml 文件中添加了 site_favicon 并使用了 readthedocs 主题。但它不工作

谁能帮我这个?

0 投票
0 回答
55 浏览

markdown - 打印 mkdocs 生成的 html 页面会暴露链接

当我打印一个 mkdocs 生成的 html 页面(在这种情况下使用谷歌浏览器)时,该页面显式地打印页面链接下的相对路径。例如:

在 mkdocs 降价文件中:

在生成的 HTML 页面上:

打印html页面:

有没有办法阻止这种情况发生?

0 投票
1 回答
489 浏览

xml - MkDocs 获得完整的站点地图

我是 Nasix.js.org 的所有者,我想知道如何获取站点地图。它应该自动生成,但似乎不起作用。请参阅 nasix.js.org/sitemap.xml。所有的文档都说它会在那里,但事实并非如此。谢谢!

0 投票
1 回答
413 浏览

read-the-docs - readthedocs 是否支持 mkdocs 配置中的显式标记?

我一直在编写一些 mkdocs 文档,其中包括我想保留在 markdown 文件中而不是变成图像并嵌入它们的美人鱼图

我在这里遇到了这个很棒的解决方案:https ://github.com/squidfunk/mkdocs-material/issues/693#issuecomment-411885426

它使用 pymdown-extensions 插件的超级围栏功能来创建一个自定义代码块,该代码块在代码块内呈现美人鱼图。

它适用于本地运行的 mkdocs,但是当我提交配置文件以读取文档时,它无法通过 yaml 验证

mkdocs.yml 配置文件中的第 18 行是调用 superfences python 类的部分

查看 yaml 规范https://yaml.org/spec/1.2/spec.html显示这!!是针对显式标记的,并且它似乎已经成为规范的一部分很长一段时间(回到版本 1)。我尝试将值设为字符串,但这会导致 python 将其作为字符串读取

有谁知道 readthedocs 是否支持这一点,或者您是否能够以其他方式使其工作?

0 投票
0 回答
386 浏览

themes - Mkdocs 主题“材料”在 mac os 上不起作用

我一直在尽一切努力让 Mkdocs 主题“材料”在 Mac os 上运行,我尝试 pip 安装它并尝试了存储库克隆方法,但它仍然不起作用,显示的主题仍然是默认的,

我将 mkdocs.yml 文件更改为此

这也是

但我仍然得到默认主题

有人可以帮我弄这个吗?谢谢