dragontao/sphinx_mermaid

dragontao

Sphinx build with mermaid support

下载次数: 0状态：社区镜像维护者：dragontao仓库类型：镜像最近更新：3 年前

让 AI 帮你使用轩辕镜像？ · 展开查看说明 · 点击收起说明

如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具，协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题，请先让 AI 阅读并遵守轩辕镜像的规则文档。

只需在 AI 对话中先发送下面这句话即可：

请先完整阅读并严格遵守以下文档中的全部规则与要求：

https://xuanyuan.cloud/agents.md

在未充分阅读并理解该文档前，不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。

查看 agents.md 用法指南与完整示范。国内用户首推元宝 AI、DeepSeek 的深度思考模式，不推荐豆包 AI；Cursor 等编辑器可在对话 @ 该链接，或加入 User Rules。若 AI 无法访问外链，可打开说明文档复制全文粘贴。文档会随站点更新，复制内容可能过期，建议定期检查。

镜像标签列表与下载命令

概论

此仓库使用 dragontao/sphinx_mermaid 构建 Sphinx 文档，添加了以下插件的支持。而且支持生成 docx 文档。

TODO：添加对 https://kroki.io 的支持

https://mermaid-js.github.io/mermaid

流程图
时序图
类图
状态图
实体关系图
旅程图
甘特图
饼图
需求图

plantuml

时序图
用例图
类图
对象图
活动图
组件图
部署图
状态图
定时图
JSON 数据
YAML 数据
网络图
线框图形界面
架构图
规范和描述语言 (SDL)
http://ditaa.sourceforge.net/
甘特图
思维导图
WBS 工作分解图
数学公式
实体关系图

https://sphinxcontrib-needs.readthedocs.io/en/latest/

需求图
列表
表格
流程图
序列图
甘特图
饼图
过滤
输入图
服务图
拓展

wavedrom

时序图
波形图

mscgen

消息序列图

配置

对于 mermaid 而言，需要添加：

python
extensions.append('sphinxcontrib.mermaid')
mermaid_pdfcrop = "/usr/bin/pdfcrop" # 构建 PDF 时将图像裁剪到合适大小
mermaid_params = ['-p', '/puppeteer-config.json']

对于 plantuml 而言，或许需要 添加：

python
extensions.append('sphinxcontrib.plantuml')
plantuml = 'java -jar /usr/share/plantuml/plantuml.jar'
plantuml_output_format = 'png'

needs

python
extensions.append('sphinxcontrib.needs')

wavedrom

python
extensions.append('sphinxcontrib.wavedrom')
wavedrom_cli='wavedrom-cli'

使用

添加了新指令：

mermaid:

mermaid

plantuml:

needs:

need/req
needlist
needtable
needflow
needsequence
needgantt
needextract
needpie
needimport
needservice
needextend

wavedrom:

wavedrom

mscgen：

构建

docker pull dragontao/sphinx_mermaid
sudo docker run -v `pwd`:/notes -w /notes dragontao/sphinx_mermaid make html
sudo docker run -v `pwd`:/notes -w /notes dragontao/sphinx_mermaid make docx
sudo docker run -v `pwd`:/notes -w /notes dragontao/sphinx_mermaid make latexpdf

镜像拉取方式

您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问标签列表页面。

轩辕镜像加速拉取命令点我查看更多 sphinx_mermaid 镜像标签

docker pull docker.xuanyuan.run/dragontao/sphinx_mermaid:<标签>

使用方法：

DockerHub 原生拉取命令

docker pull dragontao/sphinx_mermaid:<标签>

轩辕镜像配置手册

按平台快速找到配置文档

一键安装

一键安装 Docker

Linux Docker 一键安装

AI

用 AI 使用轩辕镜像

agents.md · AI 对话 · 提示词

Docker

登录仓库拉取

登录认证 · 私有仓库

专属域名拉取

免登录 · 高速拉取

Linux

Docker 镜像配置

Windows / Mac

Docker Desktop 配置

MacOS OrbStack

OrbStack 容器

Apple Container

macOS 原生容器

Docker Compose

Compose 项目配置

NAS

群晖

Synology 配置

飞牛

fnOS 镜像配置

绿联

绿联 NAS

威联通

QNAP 配置

极空间

极空间 NAS

Unraid

Unraid NAS

企业仓库

其他仓库

ghcr · Quay · nvcr

Harbor 镜像源

Proxy Repository 对接

Portainer 镜像源

Registries 配置

Nexus 镜像源

Docker Proxy 缓存

开发工具

Dev Containers

VS Code 开发容器

Podman

Podman 配置指南

Singularity / Apptainer

HPC 科学计算容器

Kubernetes

K8s Containerd

Kubernetes · Containerd

K3s

轻量级集群

面板 / 网络

爱快路由

iKuai 镜像加速

宝塔面板

一键配置镜像源

需要其他帮助？请查看我们的常见问题Docker 镜像访问常见问题解答或提交工单

镜像拉取常见问题

功能

版本功能对比

功能对比 · 版本选择

支持的镜像仓库

Docker Hub · GCR · GHCR

新手拉取配置

docker search 限制

专属域名 · Hub 搜索

不支持 push

仅支持 pull · 不支持

拉取速度原因

带宽 · 缓存 · 冷热镜像

错误码

402 与流量用尽

402 · 流量包 · 充值

401 认证失败

401 · docker login

manifest unknown

标签错误 · 镜像不存在

410 Gone 排查

410 · Docker 升级

429 限流

免费版 · 专业版 · 企业版 · 请求频率

其他报错

DNS 超时

DNS 解析 · 网络超时

TLS 证书失败

no matching manifest（架构）

账号

失败是否计费

manifest · blob · 计费

申请开发票（企业 / 个人）

企业 · 个人 · 工单

修改登录密码

网站 · 仓库 · 重置

注销账户

工单 · 数据 · 注销

原理

mirrors 不生效

daemon.json · 重启

去掉域名前缀

docker tag · 重命名

指定架构拉取

ARM64 · AMD64 · 多架构

latest 与「最新」

digest · 版本号 · 标签

查看全部问题→

用户好评

来自真实用户的反馈，见证轩辕镜像的优质服务

oldzhang

运维工程师

Linux服务器

"Docker访问体验非常流畅，大镜像也能快速完成下载。"