好消息!GitHub 已原生支持基于 JavaScript 的 Mermaid 图表工具

简介: 好消息!GitHub 已原生支持基于 JavaScript 的 Mermaid 图表工具

从即日起 GitHub 将原生支持基于 JavaScript 的 Mermaid 图表绘制工具。

Mermaid 通过解析类似于 Markdown 的文本语法来实现图表的创建和动态修改,让文档的更新能够及时跟上开发进度。可用于创建流程图、时序图、甘特图、类图、状态图、饼图等。

对于 GitHub 用户来说,这意味着他们能够通过丰富的可视化格式来共享信息,以提供更好的项目管理和质量,改进工作流程。

那么如何将 Mermaid 添加到 GitHub 文档中呢?

即将代码块标记为 mermaidiframe,它会生成原始 Mermaid 语法。在传递给 Mermaid.js 之后,浏览器又会将该代码转换为图表来呈现。

从即日起 GitHub 将原生支持基于 JavaScript 的 Mermaid 图表绘制工具。

Mermaid 通过解析类似于 Markdown 的文本语法来实现图表的创建和动态修改,让文档的更新能够及时跟上开发进度。可用于创建流程图、时序图、甘特图、类图、状态图、饼图等。

对于 GitHub 用户来说,这意味着他们能够通过丰富的可视化格式来共享信息,以提供更好的项目管理和质量,改进工作流程。

那么如何将 Mermaid 添加到 GitHub 文档中呢?

即将代码块标记为 mermaidiframe,它会生成原始 Mermaid 语法。在传递给 Mermaid.js 之后,浏览器又会将该代码转换为图表来呈现。

image.png

文档提升工作效率 - Work

image.png

文档提升工作效率 - Open source

image.png

指导文档的比例

image.png

自述文档比例

github

文档提升工作效率 - Work

image.png

文档提升工作效率 - Open source

image.png

指导文档的比例

image.png

自述文档比例

github

相关文章
|
资源调度 JavaScript
nodeJS 的 npm 设置国内高速镜像之淘宝镜像的方法
nodeJS 的 npm 设置国内高速镜像之淘宝镜像的方法
9080 2
|
9月前
|
存储 供应链 物联网
RFID智能货架成为仓库管理趋势
RFID智能货架正成为仓库管理的重要趋势,通过内置读写器实时读取货物标签信息,实现库存数量、位置及出入库动态的精准掌握。它减少人工盘点需求,快速自动识别货物,提升流转效率与吞吐能力。同时,系统可精确定位货物位置,防止错放误拿,并与ERP、WMS等系统集成,提供数据分析支持科学决策。RFID货架优化空间利用,实现自动化、数字化管理,推动无人化智能仓储发展。
|
人工智能 算法 Cloud Native
华为、埃森哲都在用的培训法则:3大战场拆解与8家破局者图谱
但当企业竞争进入“深水区”,当AI技术以周为单位迭代时,堆砌知识量 → 标准化课件 → 单向灌输这套模式注定失效。真正的破局者在哪里?那些能将培训嵌入业务毛细血管,用真实项目倒逼能力跃迁,靠前沿技术直击行业痛点的机构,正在改写游戏规则。
|
机器人 Shell Python
ROS2教程05 ROS2服务
这篇文章是关于ROS2(Robot Operating System 2)服务的教程,涵盖了服务的概念、特性、命令行工具的使用,以及如何编写服务的服务器和客户端代码,并提供了测试服务通信机制的示例。
610 4
ROS2教程05 ROS2服务
|
开发框架 缓存 搜索推荐
PiliPala:开源项目真香,B站用户狂喜!这个开源APP竟能自定义主题+去广告?PiliPala隐藏功能大揭秘
嗨,大家好,我是小华同学。PiliPala 是一个基于 Flutter 开发的 BiliBili 第三方客户端,提供流畅、个性化的使用体验。核心功能包括视频浏览与推荐、用户互动、丰富的播放设置、多维度搜索和个性化主题等。相比官方客户端,PiliPala 功能更丰富、性能更优、界面更美观。
711 14
|
11月前
|
安全 小程序 API
【03】支付宝支付商户申请下户到配置完整流程-对签约申请已通过商户进行开通API支付-创建应用-申请支付宝公钥-应用公钥-支付宝密钥-配合支付宝官方证书生成工具+配置完整流程-优雅草卓伊凡
【03】支付宝支付商户申请下户到配置完整流程-对签约申请已通过商户进行开通API支付-创建应用-申请支付宝公钥-应用公钥-支付宝密钥-配合支付宝官方证书生成工具+配置完整流程-优雅草卓伊凡
907 0
【03】支付宝支付商户申请下户到配置完整流程-对签约申请已通过商户进行开通API支付-创建应用-申请支付宝公钥-应用公钥-支付宝密钥-配合支付宝官方证书生成工具+配置完整流程-优雅草卓伊凡
Proxy error: Could not proxy request
Proxy error: Could not proxy request
2833 0
Proxy error: Could not proxy request
|
安全 应用服务中间件 网络安全
渗透测试-Tomcat文件读取漏洞复现
渗透测试-Tomcat文件读取漏洞复现
419 10
|
SQL 搜索推荐 关系型数据库
MySQL 如何实现 ORDER BY 排序?
本文详细解析了MySQL中`ORDER BY`的实现原理及优化方法。通过解析与优化、执行及多种优化技术,如索引利用、内存排序、外部排序等,帮助你提升排序性能。了解其背后的机制,可显著优化查询效率。
843 4
|
存储 弹性计算 Cloud Native
2024年 | 3月云大使返佣规则
①推荐企业认证新用户首购最高可拿首购订单实付金额的45%奖励。②3月首单推广实付金额≥90元,领50元奖励。③3月【云大使采购季】达标激励活动,拉新首购达到相应阶段可额外获得最高2.5万元奖励!拉新企业用户首购达到相应阶段可额外获得最高1.5万元奖励!
2024年 | 3月云大使返佣规则