问题标签 [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 回答
346 浏览

yaml - 此处不允许使用 yml 映射值(语法)

我已经在这个 yaml 文件中删除了一半我想要的内容,试图找到一种方法来让它构建我的 mkdocs 测试站点,但我遇到了一个错误。

错误:6:4 语法错误:此处不允许映射值

0 投票
1 回答
226 浏览

css - 有没有地方可以找到 CSS 文件来自定义 MkDocs 的 Material Theme?

我目前使用 MkDocs 和 Material Theme 来创建漂亮的 wiki 和文档页面。
但是,我想自定义主题以使其通常更暗,因为我不是明亮的白色背景的忠实粉丝。但遗憾的是,我完全不擅长通过 CSS 自定义东西(这似乎是这里唯一的方法)所以我想知道是否有一个地方/站点,在那里我可以找到预定义的 CSS 文件来改变 Material 的主题/MkDocs,我喜欢的东西。

0 投票
0 回答
214 浏览

python - mkdocs 和 PIP pip-20.0.2 的问题

在新版本的 PIP 中,发生了一些奇怪的事情。尽管有这条线:

Successfully installed Markdown-3.2.1 livereload-2.6.1 lunr-0.5.6 mkdocs-1.1 nltk-3.4.5 tornado-6.0.4

当我运行这个:mkdocs --version我得到:

/codebuild/output/tmp/script.sh: 4: /codebuild/output/tmp/script.sh: mkdocs: not found

贝娄是完整的日志:

并且参考旧版本的 pip 都可以完美运行:

知道发生了什么吗?

0 投票
1 回答
226 浏览

templates - MkDocs - 让文件使用特定模板

我可能不了解 Jinja 和/或 MkDocs 的基本内容,但希望有人能指出我正确的方向。我正在构建一个静态网站并使用 MkDocs。我需要有一个登陆页面、一些文档页面和一些产品页面。其中每一个都将使用main.html以不同方式扩展的不同模板。

我不明白的是如何确保在构建我的页面时,MkDocs 知道我的哪个模板,比如landing.htmlproduct.htmldocs.html用于给定降价文件的模板,比如landing.md, product1.md, product2.md, product3.mdAnd doc1.md, doc2.mdanddoc3.md

0 投票
2 回答
304 浏览

pdf - 如何将页面转换为 pdf 并在 markdown 中包含资产下载链接?

我尝试过使用此处列出的不同插件:https ://github.com/mkdocs/mkdocs/wiki/MkDocs-Plugins#pdf--site-conversion

但是他们所有人总是给我同样的错误

AttributeError: module 'mkdocs.utils' has no attribute 'string_types'

我的 SO 是 Windows 10,所以我在获取所需的 Cairo 库时遇到了一些问题。但即使在我们用来部署页面的容器中也会出现同样的错误。

0 投票
1 回答
39 浏览

mkdocs - 在浏览器中生成 MkDocs 页面

是否可以使用 JavaScript 在浏览器中动态/动态地为 MkDocs 生成页面?在这种情况下,构建过程包括。不再需要所有必需的工具。由于构建过程会生成静态页面,我认为通常这是可能的,但没有找到任何相关信息。

0 投票
2 回答
494 浏览

mkdocs - 排除美人鱼代码块以使用 Codehilite (MkDocs) 突出显示

我正在尝试通过 mkdocs(带有材料)从 markdown 文件生成文档以在 gitlab 上发布。我的文件包括代码块和美人鱼图表,它们声明相同(在语言中有所不同)。我想使用 CodeHilite 美化代码块,但美人鱼块也将被它作为代码块处理,而不是被 mermaid-mkdocs 插件忽略。有没有办法,我可以从 codeHilite 或任何其他更改中排除某些块以同时使用两者?

0 投票
3 回答
364 浏览

javascript - 如何在 MkDocs 中将脚本添加到 head 标签?

我是 MkDocs 新手,我使用 MkDocs 建立了一个网站,我想将一些脚本添加到<head>...</head>.

我在我的降价文件顶部尝试了这段代码,但没有奏效:

我发现脚本会显示在<body>...</body>而不是在<head>...</head>.

如何放置<script><head>标签中?

0 投票
2 回答
924 浏览

python - 我在运行 mkdocs serve 命令时遇到问题

我尝试mkdocs serve在 Windows 命令提示符下运行该命令,但它不起作用。我收到以下错误:

p>

然后我注意到我的终端目录不在MkDocs 网站mkdocs.yml中所述的文件上,但是当我运行命令将目录更改为 时,出现以下错误:cdmkdocs.yml

该如何解决?

0 投票
1 回答
176 浏览

bash - 启动 bash subshel​​l 并在脚本中运行命令

我想编写一个执行以下操作的 shell 脚本:

  1. 激活pipenv虚拟环境
  2. 为我的mkdocs文档mkdocs serve启动本地开发服务器的运行

如果我做天真的事情并将其放入我的脚本中:

它失败了,因为pipenv shell“在虚拟环境中启动子外壳”。我需要将mkdocs serve命令传递到虚拟外壳(并且最好在运行脚本后进入同一个外壳)。

提前致谢!

回答

Philippe的回答有效。这就是为什么。

  1. Pipenv 允许您在虚拟环境中运行命令而无需启动 shell: /li>
  2. bash -c <insert command here>允许您将命令传递给 bash 以执行 /li>
  3. exec用于用命令替换当前的 shell 进程,以便父进程走一条路,子进程拥有 pid。这是 AskUbuntu 上的一个相关问题