From 0a0c5cae949acdb876d22d2a06fe7bc3060a6ba3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BC=A0=E4=B9=90?= Date: Fri, 6 May 2022 03:10:10 +0800 Subject: [PATCH 1/2] docs(README.zh-CN): update Chinese README --- README.zh-CN.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.zh-CN.md b/README.zh-CN.md index 33212e3b5b..93ab453a2d 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -2,13 +2,13 @@ [English](./README.md) | 简体中文 -![banner](./img/header.png) + :trophy: **Mermaid 被提名并获得了 [JS Open Source Awards (2019)](https://osawards.com/javascript/2019) 的 "The most exciting use of technology" 奖项!!!** **感谢所有参与进来提交 PR，解答疑问的人们! 🙏** - +Explore Mermaid.js in depth, with real-world examples, tips & tricks from the creator... The first official book on Mermaid is available for purchase. Check it out! ## 关于 Mermaid @@ -35,7 +35,7 @@ __下面是一些可以使用 Mermaid 创建的图表示例。点击 [语法](ht -## 流程图 [文档 - live editor] +### 流程图 [文档 - live editor] ``` flowchart LR @@ -52,7 +52,7 @@ C -->|One| D[Result 1] C -->|Two| E[Result 2] ``` -## 时序图 [文档 - live editor] +### 时序图 [文档 - live editor] ``` sequenceDiagram @@ -77,7 +77,7 @@ John->>Bob: How about you? Bob-->>John: Jolly good! ``` -## 甘特图 [文档 - live editor] +### 甘特图 [文档 - live editor] ``` gantt @@ -100,7 +100,7 @@ gantt Parallel 4 : des6, after des4, 1d ``` -## 类图 [文档 - live editor] +### 类图 [文档 - live editor] ``` classDiagram @@ -139,7 +139,7 @@ class Class10 { } ``` -## 状态图 [文档 - live editor] +### 状态图 [[docs - live editor] ``` stateDiagram-v2 @@ -160,7 +160,7 @@ Moving --> Crash Crash --> [*] ``` -## 饼图 [文档 - live editor] +### 饼图 [文档 - live editor] ``` pie @@ -175,9 +175,9 @@ pie "Rats" : 15 ``` -## Git图 [实验特性 - live editor] +### Git图 [实验特性 - live editor] -## 用户体验旅程图 [文档 - live editor] +### 用户体验旅程图 [文档 - live editor] ``` journey @@ -202,7 +202,7 @@ pie Sit down: 3: Me ``` -### 发布 +## 发布 对于有权限的同学来说，你可以通过以下步骤来完成发布操作： From 426912583818eb17e43825894b4c6223c3923d20 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BC=A0=E4=B9=90?= Date: Fri, 6 May 2022 03:24:44 +0800 Subject: [PATCH 2/2] docs(README.zh-CN): add tutorials link --- README.zh-CN.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.zh-CN.md b/README.zh-CN.md index 93ab453a2d..63a3ee4aa6 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -23,7 +23,7 @@ Mermaid 通过允许用户创建便于修改的图表来解决这一难题，它 Mermaid 甚至能让非程序员也能通过 [Mermaid Live Editor](https://mermaid-js.github.io/mermaid-live-editor/) 轻松创建详细的图表。
你可以访问 [教程](./docs/Tutorials.md) 来查看 Live Editor 的视频教程，也可以查看 [Mermaid 的集成和使用](./docs/integrations.md) 这个清单来检查你的文档工具是否已经集成了 Mermaid 支持。 -如果想要查看关于 Mermaid 更详细的介绍及基础使用方式，可以查看 [入门指引](./docs/n00b-overview.md) and [用法](./docs/usage.md). +如果想要查看关于 Mermaid 更详细的介绍及基础使用方式，可以查看 [入门指引](./docs/n00b-overview.md), [用法](./docs/usage.md) 和 [教程](./docs/Tutorials.md). 🌐 [CDN](https://unpkg.com/mermaid/) | 📖 [文档](https://mermaidjs.github.io) | 🙌 [贡献](https://github.com/mermaid-js/mermaid/blob/develop/CONTRIBUTING.md) | 📜 [更新日志](./docs/CHANGELOG.md)