问题标签 [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 投票
0 回答
548 浏览

github - 使用 mkdocs Github 页面未更新,但 gh-pages 分支有最新更改

有一些类似的问题,但其他问题中提到的解决方案都不能解决我的问题。

我正在使用mkdocs发布 github 页面。我正在使用的命令是mkdocs gh-deploy --clean

这在过去工作正常。但是现在突然对其中一个页面进行了小的拼写更改后,这些更改并没有反映在 git pages 网站中。请注意,在 gh-pages 分支中,我可以看到更改已正确推送。

gh-pages 分支不应该一直与 github pages 网站同步吗?

我在这里想念什么?

//编辑:

换句话说,这个问题,它是一个使用 mkdocs 构建的静态站点。如果 gh-pages 分支具有所有更改(并且在本地工作正常),那么它不应该自动更新 github pages 站点。据我了解,静态 github 页面站点不涉及构建过程。

0 投票
2 回答
672 浏览

css - mkdocs 和 markdown:base.css 覆盖自定义 css

我是 mkdocs 的新手,这就是我想要做的:为图像添加标题并使用 css 样式来使用较短的边距底部我设法安装了 python-makdown 扩展“标题”,所以如果我利用

我去拿

在 html 中。不幸的是,间距(css:margin)太大,所以我包含了一个css文件来删除默认值。我的浏览器中的检查现在向我显示,base.css 覆盖了我的样式,因此边距保持默认。如何用自己的样式覆盖 base.css 样式?

正如我在评论中所写,!important 保证覆盖:

但我不明白为什么...

0 投票
1 回答
188 浏览

javascript - Markdown 无法结合 fenced_code 和 attr_list

我正在尝试为 mkdocs 编写降价文件,并想要一个带有 pre 标记的 id 属性,生成为 fenced_code。如果我结合使用这两个扩展,则没有前置标签,而是 ap(aragraph 标签):

打印退货

但我期待

在我实际使用的 mkdocs 下也是如此。我需要 id 通过 javascript 访问它并运行嵌入的 python 代码机智 skulpt。有没有解决方案来实现这一目标?

0 投票
1 回答
1912 浏览

nginx - mkdocs nginx 反向代理慢

我已经设置 mkdocs 并在端口 8000 上运行,Nginx 设置为具有以下配置的反向代理。但是,当通过反向代理浏览器访问该站点时,浏览器会长时间保持“连接...”大约 2 分钟并加载页面。此外,如果我在浏览器中以“X”停止,整个页面会立即显示。有人可以帮忙吗?

而 nginx.conf 是

0 投票
0 回答
54 浏览

python - 子进程立即杀死父进程

当我尝试mkdocs serve作为子进程运行并使用 CTRL+C 退出 MkDocs 服务器时,父 Python 进程也会立即退出。甚至没有调用注册的 finally 子句或函数atexit

到底他妈发生了什么?查看命令的执行后,我找不到任何可疑之处mkdocs serve。在 Windows 上使用 Python 3.4 进行测试。


更新:原来这似乎是 Windows 上的 Mintty (GitForWindows) 的问题。如果我从 Cmder 或本机 Windows 命令提示符运行 Python 脚本,一切正常。

0 投票
1 回答
102 浏览

mkdocs - 如何从使用 mkdocs 编写的页面将链接添加回我的主页?

我正在建立一个也有文档页面的通用网站。对于文档页面,我使用的是 mkdocs。我想要文档页面中的链接,最好是在右上角,该链接可以返回到我的主网页。我知道如何将链接放在文档中,但我希望它看起来像标题。有没有办法做到这一点?

0 投票
3 回答
2554 浏览

html - MkDocs 中的全局变量

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

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

...然后,在页面中使用该变量,例如如下:

我试过了,但不幸的是它在我的例子中不起作用(没有变量替代):

在此处输入图像描述

  • 难道我做错了什么?
  • 有可能使这项工作吗?
0 投票
1 回答
312 浏览

function - 如何在 mkdocs 中编写函数语法

我需要什么markdown语法来编写如下的api。 在此处输入图像描述

html代码如下:
链接

我尝试过使用这样的语法,但结果却是一样但不一样。

在此处输入图像描述

每一个答案将不胜感激。

0 投票
1 回答
129 浏览

python - mkdocs-pandoc TypeError: _split_row() 正好采用 2 个参数(给定 3 个)

当我尝试使用 mkdocs2pandoc 生成 .pd 时,出现以下错误

我刚刚开始了新的虚拟环境,并且只安装了 mkdocs-pandoc

0 投票
0 回答
183 浏览

deserialization - 使用 YamlDotNet 反序列化 MkDocs.yml 页面对象

我正在开发一个将多个文档源转换为 MkDocs 项目的项目。MkDocs 项目文件 MkDocs.yml 是一个 YAML 文档。我需要反序列化现有页面,以便可以通过 C# 控制台应用程序在该项目中插入新的 .md 页面和标题。

示例 MkDocs.yml 文件

我使用 YamlDotNet 提供的 DeserializeObjectGraph 单元测试来测试页面反序列化。测试总是失败,但出现以下异常:

执行附加单元测试时产生异常

我猜我需要在 Page 类或其属性之一上放置某种类型的属性。有没有人有反序列化类似这样的结构的经验?如果是这样,你可以发布一个样本给我一些参考吗?

这是我使用的输入 DeserializeObjectGraph.cs: