Markdown 拓展-Gitlab/Github 開啟 UML 圖支持

為什么需要它

一些可視化工具再給我們帶來直觀性的同時(shí)典阵,也增加了操作的難度倒慧,需要精細(xì)地調(diào)整組件的大小和樣式,更多的時(shí)候,我們不是為了寫一份漂亮的報(bào)告而畫流程圖,只是需要便捷地向他人分享自己的 idea,在這樣的需求下,代碼生成流程圖顯然更適合屯援。

對(duì) gitlab 的支持

You can generate diagrams and flowcharts from text by using Mermaid or PlantUML. You can also use Kroki to create a wide variety of diagrams.

gitlab 配置 plantuml

plantuml/plantuml-server: PlantUML Online Server
https://github.com/plantuml/plantuml-server

plantuml-server 啟動(dòng)完成后,需要在 GitLab 上配置開啟 PlantUML念脯,管理員登錄 -> Admin Area -> Settings狞洋,復(fù)選框選中 Enable PlantUML,輸入 PlantUML URL(就是剛剛啟動(dòng)的 PlantUML Server 服務(wù)監(jiān)聽地址)绿店。好了現(xiàn)在可以開始 PlantUML 之旅了徘铝。

gitlab 配置 Mermaid

在 GitLab 10.3 中引入 。您可以訪問官方頁面以獲取更多詳細(xì)信息惯吕。

gitlab 配置 Kroki

可以訪問官方頁面以獲取更多詳細(xì)信息。

對(duì) github 的支持

支持時(shí)間:https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/

目前版本已內(nèi)置怕午,可以直接使用废登。

mermaid-js/mermaid: Generation of diagram and flowchart from text in a similar manner as markdown
https://github.com/mermaid-js/mermaid

對(duì) mermaid 的詳細(xì)說明

如果您不熟悉使用 Mermaid,或者需要幫助來確定 Mermaid 代碼中的問題郁惜,則 Mermaid Live Editor 是一個(gè)有用的工具堡距,可用于在 Mermaid 圖中創(chuàng)建和解決問題。

Mermaid 支持軟件項(xiàng)目中一系列不同的常見圖表類型兆蕉,涵蓋流程圖羽戒、UML、Git 圖虎韵、用戶體驗(yàn)流程圖易稠,甚至可怕的甘特圖。

To generate a diagram or flowchart, write your text inside the mermaid block:

```mermaid
graph TD;
  A-->B;
  A-->C;
  B-->D;
  C-->D;

對(duì) Typora 的支持

真正實(shí)現(xiàn)畫圖功能的并不是 Typora 本身包蓝,它只是內(nèi)置了對(duì) Mermaid 的支持驶社。Mermaid 集成功能建議去 gitlab 和 GitHub 查看幫助文檔,了解更多信息测萎。

總結(jié)

由于無論 gitlab 還是 GitHub 都對(duì) Mermaid 有了良好的支持亡电,在對(duì)比渲染流程,所以我優(yōu)先考慮此方式硅瞧。

參考文檔

GitLab Flavored Markdown | GitLab
https://docs.gitlab.com/ee/user/markdown.html#mermaid

GitLab Markdown - 《Gitlab 中文文檔》 - 書棧網(wǎng) · BookStack
https://www.bookstack.cn/read/gitlab-doc-zh/docs-408.md#mermaid

Mermaid:如何在Markdown文本中添加流程圖份乒,附支持github的方法_DenryDu的博客-CSDN博客_gitlab mermaid
https://blog.csdn.net/weixin_43661154/article/details/112101437

Typora通過mermaid使用流程圖、腦圖-CSDN博客_mermaid 思維導(dǎo)圖
https://blog.csdn.net/Alexhcf/article/details/112801877

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市或辖,隨后出現(xiàn)的幾起案子瘾英,更是在濱河造成了極大的恐慌,老刑警劉巖孝凌,帶你破解...
    沈念sama閱讀 212,029評(píng)論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件方咆,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡蟀架,警方通過查閱死者的電腦和手機(jī)瓣赂,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,395評(píng)論 3 385
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來片拍,“玉大人煌集,你說我怎么就攤上這事“剖。” “怎么了苫纤?”我有些...
    開封第一講書人閱讀 157,570評(píng)論 0 348
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)纲缓。 經(jīng)常有香客問我卷拘,道長(zhǎng),這世上最難降的妖魔是什么祝高? 我笑而不...
    開封第一講書人閱讀 56,535評(píng)論 1 284
  • 正文 為了忘掉前任栗弟,我火速辦了婚禮,結(jié)果婚禮上工闺,老公的妹妹穿的比我還像新娘乍赫。我一直安慰自己,他們只是感情好陆蟆,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,650評(píng)論 6 386
  • 文/花漫 我一把揭開白布雷厂。 她就那樣靜靜地躺著,像睡著了一般叠殷。 火紅的嫁衣襯著肌膚如雪改鲫。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,850評(píng)論 1 290
  • 那天溪猿,我揣著相機(jī)與錄音钩杰,去河邊找鬼。 笑死诊县,一個(gè)胖子當(dāng)著我的面吹牛讲弄,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播依痊,決...
    沈念sama閱讀 39,006評(píng)論 3 408
  • 文/蒼蘭香墨 我猛地睜開眼避除,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼怎披!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起瓶摆,我...
    開封第一講書人閱讀 37,747評(píng)論 0 268
  • 序言:老撾萬榮一對(duì)情侶失蹤凉逛,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后群井,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體状飞,經(jīng)...
    沈念sama閱讀 44,207評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,536評(píng)論 2 327
  • 正文 我和宋清朗相戀三年书斜,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了诬辈。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,683評(píng)論 1 341
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡荐吉,死狀恐怖焙糟,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情样屠,我是刑警寧澤穿撮,帶...
    沈念sama閱讀 34,342評(píng)論 4 330
  • 正文 年R本政府宣布,位于F島的核電站痪欲,受9級(jí)特大地震影響悦穿,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜业踢,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,964評(píng)論 3 315
  • 文/蒙蒙 一咧党、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧陨亡,春花似錦、人聲如沸深员。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,772評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽倦畅。三九已至遮糖,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間叠赐,已是汗流浹背欲账。 一陣腳步聲響...
    開封第一講書人閱讀 32,004評(píng)論 1 266
  • 我被黑心中介騙來泰國(guó)打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留芭概,地道東北人赛不。 一個(gè)月前我還...
    沈念sama閱讀 46,401評(píng)論 2 360
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像罢洲,于是被迫代替她去往敵國(guó)和親踢故。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,566評(píng)論 2 349

推薦閱讀更多精彩內(nèi)容