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

pdf - 将 Markdown 文件转换为 pdf 时如何保留/强制格式化?

如何将 Markdown 文件转换为 PDF 并保留代码块格式?

降价代码

通过 Mkdocs 提供的服务看起来像:

EX_1

在此处输入图像描述

将 Markdown 文件转换为 PDF(或 docx 等)后,格式如下所示:

EX_2

在此处输入图像描述

我需要保留 EX_1 中所示的背景颜色和行号。

0 投票
1 回答
1237 浏览

python - 在 Python 文档中嵌入图像

我有一个 python 项目,我想创建文档...

在本文档中,允许嵌入图像至关重要。另外,我不想创建单独的文件。换句话说:*.py 文件将包含脚本和文档(嵌入了图像)。

当然,稍后此 *.py 将由工具处理以创建降价或 HTML 报告。

我查看了mkDocsSphinx,但我不确定它们是否支持这些要求。

有谁知道如何使用这些工具(或其他工具)做类似的事情?

0 投票
1 回答
2365 浏览

css - 如何在 MkDocs 材质主题中添加自定义内联样式

我一直在寻找一种将自定义样式添加到我的降价页面的方法。我已经能够将“extra_css”添加到 yml 文件中,但这似乎只会影响生成的 html。例如,我能够为图像添加自定义样式,使所有项目居中。

我知道有一种方法可以使用类似的东西添加属性

所以这是一个两部分的问题:

  1. 我在哪里创建样式?在我在 yml 中声明的自定义 css 文件中?

示例:extra_css:
-custom.css

  1. 如何在我的降价中内联引用(应用)它们?
0 投票
0 回答
317 浏览

markdown - Mkdocs 警告:404 GET require.js

我以前使用过 Mkdocs,但是当我升级/重新安装 Python、Pip 和 Mkdocs 时,通过 Markdown 制作的任何内容都不会显示;构建成功并通过 localhost 显示我的网页,但没有从 Markdown 输出任何内容。相反,在我的 VSCode 终端上显示了一个警告,似乎需要一个“require.js”文件——我错过了一个文件吗?

还检查了我的 mkdocs 安装:

这是我的 Python 和 PIP 版本:

我还在我的环境变量中添加了建议的路径(成功安装 mkdocs 后)。

谢谢

0 投票
1 回答
1864 浏览

mkdocs - 如何链接pdf

我试图[here](adevertising.pdf)链接一个 pdf,它与我的 markdown 文件位于同一文件夹中,但是当我单击该链接时,我最终会出现 404 page not found 错误。

如何创建将用户重定向到存储在同一文件夹中的 pdf 的链接?

0 投票
2 回答
1694 浏览

python - 在 Travis CI 中自动构建 Mkdocs 文档

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

0 投票
1 回答
412 浏览

email - 在 mkdocs 中集成时事通讯注册表单

我知道 mkdocs 是一个没有第三方集成/表单的静态站点。

我需要将时事通讯注册表单添加到 mkdocs 生成的页面。

我怎样才能做到这一点?网上好像有0%的信息。

0 投票
1 回答
520 浏览

python - mkdocs:使用自定义 python 模块来补充插件

我想为 mkdocs 编写一个插件,允许添加自定义 python 代码文件。这是一个插件示例

我想将模块放在网站的主目录中,在mkdocs.yml文件旁边,并在其中声明该模块,例如:

然后我会在插件的代码中使用,例如:

我此时遇到的问题是我不知道模块的代码如何知道 yaml 文件的位置或 markdown 文件的位置。无论如何,这会成为config字典的一部分吗?

更新

我编写了插件并在 github 上提供了它。非常感谢你的帮助。

0 投票
0 回答
774 浏览

reactjs - Gatsby/Hugo/MKDocs 用于 React SPA 中的降价文档,具有动态功能

我需要建立一个具有动态功能的网站 - 具有搜索和发布以及从 RESTful API 接收数据。我们决定在前端使用 React.js。我们还需要应用程序中的文档,这些文档将被编写并存储在 Markdown 中。

你对选择 Hugo Gatsby 还是 MK Docs 有什么建议吗?Hugo 和 MKDocs 似乎有更多可用的主题,但我不确定将这两者中的任何一个与 React 混合起来有多容易?我知道 Gatsby 是基于 React 的,但似乎可用的主题较少。

如果有人有类似的选择,您可以分享您的经验吗?当然,也许还有一些关于开源文章或存储库的链接,我可以用它们来了解如何构建这样一个项目?特别是将 Hugo 和 MKDocs 与 react SPA 混合的例子?到目前为止,我还没有找到任何工作的。任何关于在设置和做出决定时关注什么的提示都将非常感激。

谢谢

0 投票
1 回答
521 浏览

markdown - 如何更改语言插件“搜索”?

我使用降价。有一个插件叫搜索。在这个插件中,搜索俄语单词不起作用,但搜索英语单词有效。如何在此插件中搜索英语和俄语单词?