当前位置:首页 > draw.io教程

在 GitHub Markdown 中嵌入图表

drawio6年前 (2020-08-24)draw.io教程9

您可以在 GitHub README 文件中以多种不同的方式使用版本化的图表,并包含用于编辑图表或将其用作新图表模板的链接。

即使您不打算在 README 文件中显示图表,您也可以使用 GitHub 作为图表的存储位置。

与 GitHub 集成以显示和编辑图表时,使用了 draw.io 编辑器的嵌入模式,其中图表的存储由宿主应用程序 (GitHub) 负责,而我们的在线编辑器 (app.diagrams.net) 用于图表编辑。

Github 中的嵌入式图表和图表编辑支持以下文件格式:.png、、.svg.html.xml默认)

在 GitHub Wiki Markdown 中嵌入图表

  1. 将图表保存为可编辑格式.png.svg图片格式。

    • 编辑图表时,选择“文件”>“导出为”>“PNG”“文件”>“导出为”>“SVG”,并确保选中“包含我的图表副本”复选框。

  2. 在你的 GitHub Markdown 文件中,像往常一样插入这些图片,可以添加或不添加替代文字。例如:![Alt text here](images/someimage.png)

在 GitHub wiki 页面上查看此图表示例

编辑 GitHub README 中的图表

使用从我们的 GitHub 存储库中获取的文件edit-diagram.html您可以允许具有适当访问权限的开发人员编辑嵌入在 Github markdown 页面中的图表。

该文件与 GitHub 接口,并使用 draw.io的嵌入模式edit-diagram.html允许您编辑和保存存储在存储库中的图表。以下 URL 参数是必需的:user,,,,passrepopathrefaction=open

使用 `<link> action=open` 并传递 `<link>`user和 `<link>`pass参数,即可创建允许开发人员立即编辑图表的链接。您的链接将类似于以下示例。

http://jgraph.github.io/drawio-github/edit-diagram.html?repo=drawio-github&path=diagram.png

查看此 GitHub README 文件,其中包含可编辑的图表

使用 GitHub 中的图表作为模板

将图表作为URL 参数传递给 app.diagrams.net 上的 draw.io 编辑器,即可使用 GitHub 上存储的图表作为模板。您的链接将类似于以下示例:

https://app.diagrams.net/#Uhttps%3A%2F%2Fraw.githubusercontent.com%2Fjgraph%2Fdrawio-github%2Fmaster%2Fdiagram.png

在 GitHub Markdown 中嵌入可自编辑的 SVG 图像

您可以显示嵌入了 PNG 数据的 SVG 文件(以支持无法使用 PNG 的 Internet Explorer 用户foreignObject)。该 SVG 文件结合了图像格式(可将其包含在 Markdown 中<img src="...">)和用于 GitHub 集成的脚本。

要编辑这种“自编辑”SVG图像,您需要构建如下链接:

http://jgraph.github.io/drawio-github/self-editing.svg

使用HTML作为自编辑图表的容器

您可以构建一个带有嵌入式图表的“自编辑”HTML文件,利用nanocms.jsGitHub界面和图表编辑功能,以及Bootstrap和nanocms.cssCSS样式。HTML可以以这种方式与多种格式的图表一起使用,包括包含链接的内联SVG。

请看下面这个包含图表的可自编辑HTML文件示例。