我正在尝试生成自动文档,使用: mkdocs = "^1.4.2" mkdocstrings = "0.19.0" mkdocs-material = "8.5.8" mkdocstrings-python = "0.7.1" 我的 mkdocs.yml 看起来像这样: index.md 仍然是 ...
我正在尝试生成自动文档,使用: mkdocs = "^1.4.2" mkdocstrings = "0.19.0" mkdocs-material = "8.5.8" mkdocstrings-python = "0.7.1" 我的 mkdocs.yml 看起来像这样: index.md 仍然是 ...
mkdocs 的文档描述了一种方法来包含一些额外的 css 定制,而无需像使用 custom_theme 目录那样覆盖整个文件。 考虑以下示例: mkdocs.yml :site_name: MWE nav: - 'Home': index.md theme: name: mkdocs ...
我正在使用mkdocs 、 mkdocs-smae-dir 、 mkdocs-simple 、 mkdocstrings和mkdocstrings-python-legacy记录一个小的 package 。 当我尝试使用mkdocs-serve查看我的文档时,它会产生以下属性错误,Attribut ...
我无法让 mkdocs 在提交时由 GitHub 操作运行的容器中工作。 大家好, 我一直在尝试在 GitHub 上获取我的 python 代码文档。我已经设法通过运行 GitHub 操作来做到这一点 使用以下 GitHub 操作流程: 问题是 mkdocstrings 不起作用,因此网页上没有显示 ...
我正在使用材料 mkdocs package,我想突出显示 JSON 代码块的第 7-31 行,但我不确定该怎么做。 我已经查看了文档并尝试了一段时间,但没有任何方法可以解决我的问题。 有谁知道如何解决这个简单的问题? ...
目前,我正在使用mkdocs-material来使用美人鱼图,配置如下(在mkdocs.yml中):... markdown_extensions: - pymdownx.superfences: custom_fences: - name: mermaid cl ...
我正在为我的用户使用material mkdocs作为我的外部文档。 我想知道如何在文档中实现在不同操作系统命令之间切换的效果? 我从Django Docs tutorial得到了这张截图 ...
我将使用MKDocs来制作文档,但它说: 我已经在2022年10月23日的Commits中推送了github commit e8221fc1f0402834b6db92280e67e9fcac4a2b10中的内容,我该如何完成呢? 为什么失败了? PS 这是/home/phao/桌面/python ...
我已启用 Github 操作以在提交后创建技术文档。 下面是为创建 Md 文件而编写的工作流文件。 但是“techdocs-cli generate --no-docker --verbose”命令失败并出现以下错误。 有人可以帮忙解决这个问题吗? 无法从 /home/runner/work/mya ...
当我想在我的文档中附加bar模块的文档字符串时,我把::: foo.bar 在 markdown 文件中。 它附加了bar文件中的所有文档字符串 - 模块文档字符串和Bar class 文档字符串。 当我只想附加Bar类文档字符串时,语法是: ::: foo.bar.Bar 现在我只想引用没有 cl ...
我正在尝试在我的 MkDocs 网页上放置这样的图像: 哪个工作正常。 但是,当我将其上传到 GitHub 时,图像不显示。 有没有办法更改链接,以便它们在 GitHub 和 MkDocs 网页上工作? 谢谢! ...
使用 mkdocs,我转换了一些包含技术信息的 markdown 表。 我想用 css 为这些表格设置样式 - 但不是网站上的每个表格。 我的目标是为某些表设置一个 id 或 class 。 我原来的markdown(例子) 使用“材料”主题生成 html。 使用主题中的 javascript 插 ...
我正在尝试使用 mkdocs 来自动生成导航。 nav 是按文件名的字母数字顺序自动生成的。 但是,当其中有目录时,它就不能正常工作。 有没有更好的办法? 文件树 结果 期望的结果 ...
我正在使用MkDocs和Material for MkDocs编写文档。 我想在index.md中有一个图像,当我从浅色模式切换到深色模式时,它可以在两个不同的版本之间切换,反之亦然。 我在网上找到了不同的解决方案,但它们似乎都不起作用。<picture> <source ...
似乎无法将Mkdocs(材料)站点部署到 Azure Web 应用程序。 我们为我们的抵押品和文档建立了一个Mkdocs 站点,我曾多次尝试使用Azure(网络应用程序、static 应用程序和 DevOps)来托管它,但似乎没有任何效果。 最好不要使用Git 页面或第 3 方托管应用程序下面是我的 ...
我想在后台应用程序(而不是每个 Docs 文件夹中)的全局级别更改 techdocs 主题及其 colors。 我怎样才能做到这一点? 示例:更改所有代码片段的背景颜色。 ...
我正在使用 mkdocs 为我的项目生成文档,现在我无法将这些文档部署到 Github 页,它告诉我: 远程:XXX.git 的权限被 github-actions[bot] 拒绝。 致命:无法访问“XXX”:请求的 URL 返回错误:403 这是我的CI配置。 还有我的存储库秘密:(这两个GIT_ ...
我正在尝试在 backstage-io /docs 页面 UI 上显示存储在由后台 io 组件创建的存储库中的文档,但是当我尝试访问文档时出现以下错误 我的存储库中的文件 docs 文件夹只有 index.md 和 mkdocs.yml 有 ...
背景:我有一个包含多个子目录的仓库。 例如 每个子目录在 Github 中都有自己的版本标签。 例如 Foo v1.0.0 Bar v2.0.0 我目前正在为我开始使用 Mkdocs 研究的每个子目录探索一个单独的版本控制文档,并将该文档托管在 Github Pages 中。 虽然我可以使用 ...
在终端中键入 mkdocs serve 时出现以下错误: 错误 - 读取页面 'codereference.md' 时出错:<class '_ast.ExtSlice'>(有很长的回溯,见下文) 我的 mkdocs.yaml 文件是: codereference.md 文件包含 ...