首页
学习
活动
专区
圈层
工具
发布

PlantUML——程序员画架构图都靠它

引言 作图可以说是程序员的必备技能,最近发现身边同学们主要还是在用 OmniGraffle、ProcessOn、draw.io 这类软件作图,用的过程中可以思考一下下面这些问题是否困扰了你: 版本管理困难...、团队协作困难、二次编辑困难:假如老文档中的设计图需要修改,是你画的还好就是找源文件得费点功夫,如果不是你画的那就别想找到源文件了,别指望可以二次编辑了,重画吧; 作图效率不够高:如果希望作图质量保持一定的水准...,心智自然; 超强的可维护性:永远不用担心图的源文件丢了,它自己本身就是源文件,避免了文档维护的割裂; 容易实现版本管理、团队协同; 具体语法没必要展开讲,和 markdown 一样简单,官网讲得非常清楚...开启预览的效果: 对于java开发者,则更推荐使用IDEA的插件PlantUml integration,这款插件渲染图片的速度比vscode的插件更快,每次渲染时间都有显示(测试结果简单的图只要100ms...> 方式二(自搭建服务渲染):下载渲染服务 jar 包 https://plantuml.com/zh/download,本地启动,在 GUI 中选择要渲染的路径,这个设定比较奇怪,它会自动扫描路径下的所有可渲染文件自动生成目标图片

9.3K21

使用 PlantUML 享受流式绘图

PlantUML 介绍 PlantUML 是一款优秀的 UML 图绘制工具,使用它可以方便快捷地绘制 UML 图。...我个人认为它的存在意义与 Markdown 非常相似,Markdown 的功能是流式描述文档,而 PlantUML 的功能是流式描述 UML 图,用户只需要把精力放在 UML 图的描述上,而无需关心排版...,在扩展中寻找 PlantUML 并安装即可: PlantUML Extension 到这里 PlantUML 绘图环境的搭建就完成了。...开始绘图 PlantUML 官方的语法说明在这:PlantUML,支持的 UML 图种类有很多,这里以序列图为例,给一个简单的例子: @startuml A -> B : hello() B -> C...),然后键入 PlantUML,选择 Preview Current Diagram 项并回车,就可以看到 UML 图效果了: Preview 其他的 UML 图也类似,快去官网学习一下语法,然后体验极速绘图的快乐吧

92420
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

    Markdown 的系统介绍和使用技巧

    (可以高亮显示) shell 没有输出就不要加 符号代表命令,如果有输出就加上 代表命令行 没有输出推荐使用: ls -al 有输出推荐(主要区分命令和输出): $ echo 'test' test...如果如下: [ ] 待处理 [ ] 待处理 [x] 已完成 plantUML 流程图 Markdown 已经快逆天了,已经结合 PlantUML 语法在文档里面画流程图了(微信因为不兼容 plantUML...展示,所以这里无法展示了,大家可以在 MPE 插件中看到效果) Bob -> Alice : hello Alice -> Bob : hi 关于排版的几个小技巧 关于如何写出美观、好读文章的几点建议...在 VSCode 中的技巧 Markdown 预览快捷键:shift + command + v 增强预览插件:Markdown Preview Enhanced MPE 插件 全称:Markdown...格式化功能:Format Document 提供代码模版:markdown.json 语法检查等等 工具推荐 markdown 写公众号工具 Online-Markdown:在线预览内容,复制到公众号可以保持格式

    1.8K20

    AI 应用之文章转脑图的 N 种姿势

    希望大家在日常工作和生活中,能够根据自己的特点定制各种符合自己需求的 Agent 来辅助自己高效解决问题。 注:这里的文章可以是技术文章,可以是报告,也可以是论文等。 二、为什么?...这里主要两种思路:一种是将文章转为思维导图,然后将思维导图导入 Xmind 中;一种是让 AI 直接将文章内容使用 PlantUML 语法输出为脑图。...文件 导入 Xmind 之前,需要将 markdown 文本保存为 markdown 文件,可以直接本地使用记事本另存为,也可以使用在线的工具如 dillinger 导出为 markdown 格式的文件...(3)导入思维导图 默认如下样式: 大家可以根据自己的喜好,在【格式】 - 【骨架】 中修改为括号图、矩阵图等更喜欢的图形: 括号图 矩阵图 3.2 通过 PlantUML 脑图 参考提示词...【文本绘图】的形式插入到语雀中展示;也可以在 IDEA 开发工具中安装 PlantUML 插件,在 IDE 中渲染。

    50100

    【架构治理】在代码存储库中记录软件架构

    Markdown 是一种标准的简单语法,用于创建具有专业外观的文档。它比 HTML 更简单,无需专门的编写编辑器即可进行管理。Git配置管理工具也支持markdown格式。...在 Git 环境中,markdown 一般用于项目的简单介绍和构建说明。(自述文件)。本文介绍了如何将 Markdown 格式与模板一起用于架构文档。...这样,您可以将整个设计(包括绘图)保存在一个地方。您放入 Markdown 文档中的 UML 和 C4 图可以在预览窗口中看到。(带有一个名为“PlantUML”的插件)。...GIT 工具具有可视化显示在此 PlantUML 中编写的设计脚本的功能。通过这种方式,可以看到带有 Bitbucket 的设计(具有适当的版本和配置)。...相关网站上有一个草稿作为单个文件或作为每个部分的单独文件。 您可以在此模板中使用 C4 模型和 UML 图。例如,我们可以使用第 3 章中的 C4 范围图,第 5 章中的容器图和组件图。

    2K20

    好用的博客生成编辑器MWeb Pro for mac

    MWeb Pro for mac是mac上一款支持markdown编辑器标记语言的简约文本编辑器,能方便地用Markdown记日记、简单的管理日记并生成博客。而写日记时插入图片的功能是经常用到的。...可拖拽或直接粘贴即可插入图片并显示出来。安装包:https://www.macw.com/mac/428.html?...Markdown语法:使用github Flavored Markdown语法(GFM)。支持表,TOC,LaTeX,Fenced代码块,任务列表,脚注等。...Markdown图形支持美人鱼,即echarts,plantuml,序列,流程。辅助支持屏幕截图并粘贴,复制和粘贴,拖放插入图像并直接在编辑器中显示。支持在与Markdown语法兼容时设置图像宽度。...文档可以分为多个类别。您可以将类别导出到Epub,PDF并生成静态网站。记笔记,个人知识收集,管理和输出都很有用。快速注意。快速搜索。外部文件外部降价文档使用外部模式。

    1.1K20

    Yank Note 高度可扩展的 Markdown 编辑器

    它支持多光标编辑、自动完成基本 Markdown 语法,并可以通过插件进一步扩展这些功能。 文档管理:Yank Note 支持文档的历史版本回溯,可以轻松查看和恢复之前的版本。...嵌入功能:可以在文档中嵌入可运行的代码块(支持多种语言)和 HTML 小工具,提高学习和工作的效率。...,可作为文件或 Base64 形式插入 嵌入附件: 可以添加附件到文档,点击在系统中打开 代码运行: 支持运行 JavaScript、PHP、nodejs、Python、bash 代码...待办列表: 支持显示文档中的待办进度,点击可快速切换待办状态 快速打开: 可使用快捷键打开文件切换面板,以便快捷打开文件,标记的文件,全文搜索文件内容 内置终端: 支持在编辑器打开终端,快速切换当前工作目录...复制标题链接: 复制标题链接路径到剪切板,便于插入到其他文件 嵌入小工具: 文档支持内嵌 HTML 小工具 嵌入 PlantUML 图形: 在文档内内嵌 PlantUML 图形 嵌入

    58810

    美哭了,一款面向程序员的 Markdown 应用,功能属实有点强...

    功能强大:支持历史版本回溯;可在文档中嵌入小工具、可运行的代码块、表格、PlantUML 图形、Drawio 图形、宏替换等;支持接入 OpenAI 自动补全。...兼容性强:数据保存为本地 Markdown 文件;拓展功能尽量用 Markdown 原有的语法实现。 插件拓展:支持用户编写自己的插件来拓展编辑器的功能。...Base64 形式插入 嵌入附件: 可以添加附件到文档,点击在系统中打开 代码运行: 支持运行 JavaScript、PHP、nodejs、Python、bash 代码 待办列表: 支持显示文档中的待办进度...HTML 代码,也可以使用快捷键粘贴复制 HTML 为 Markdown docx 导出: 后端使用 pandoc 做转换器 TOC 支持: 生成 TOC 在需要生成目录的地方写入 [toc]{type...嵌入 PlantUML 图形: 在文档内内嵌 PlantUML 图形 嵌入 drawio 图形: 在文档中内嵌 drawio 图形 嵌入 ECharts 图形: 在文档中嵌入 Echarts 图形 嵌入

    1.7K21

    VNote:一个更懂程序员和 Markdown 的笔记软件

    ,包括文件名、内容、标签以及大纲搜索; 底部是状态栏,包括 Vim 状态栏、标签栏、编辑器状态栏以及字数统计; 顶部是工具栏,其中包括附件、通用入口、灵犀页等常用功能; 左右两侧的栏目都可以通过一个快捷键隐藏或显示...该界面展示了 VNote 支持的主要 Markdown 元素: 所有文本都没有隐藏,而且可以直接访问; 语法高亮标题、粗体、斜体; 代码块语法高亮; 公式、图片原地预览,支持 PlantUML、Flowchart...如果是刚从 Typora 迁移过来,则很多人可能都会写错语法,因为使用 Typora 基本不用关注 Markdown 的语法,这算是 Typora 的利弊吧。...VNote 会将图片保存到与笔记文件同文件夹下面的一个文件夹,所以用其他编辑器打开 VNote 的笔记,一般都是可以正常显示图片的。另外,VNote 还会管理插入的图片,将不再需要的图片自动清理。...image.png 在 VNote 中,我基本很少使用工具栏那个传统的全文搜索了。要打开一个文件?通用入口!要查找一个关键字?通用入口!搜索所有大纲?通用入口!列出指定标签的文件?通用入口!

    5.5K31

    画图利器PlantUml

    画图有很多中工具,xmind,markdown,在线流程图工具,甚至自己的时间充裕的话可以自己开发一个画图工具,今天主要说一下plantuml。...plantuml是什么 PlantUML是一个开源项目,支持快速绘制时序图,用例图,类图,对象图,组件图,思维导图,架构图,部署图等等。...如何使用 思维导图类似markdown语法 @startmindmap * 中心 ** 主题1 ***: 主题1.1 未登录页进入,登录页进行登录; ***: 主题1.2 ** 主题2 ** 主题3 @...,时序图可以从技术的角度作为切入点,用来分析产品中的技术实现细节,组件图可以从技术的角度讲业务拆分成不同的模块进行开发,其他的图需要自己去官网查询自己学习了。...vscode中如何使用 下载插件plantuml 安装插件plantuml preview 新建.puml后缀的文件即可 今日总结 plantuml 三种图的基本用法 vscode中如何使用 plantuml

    53410

    代码即格式:你用过这些高效工具吗?

    文档神器 - Markdown 对于一个程序员来说,记笔记写总结是很经常的事情,对于程序员这类职业的人,他们对编辑器的要求大致如下: 不需要丰富的格式,因为内容才是重点; 具备代码高亮格式显示; 写起来迅速快捷...我给大家简单介绍下: markdown 它是一种轻量级的「标记语言」,“标记”我的理解是它可以通过各种符号来代表各种各样的格式,比如#代表一级标题,“语言” 我的理解是指他的语法,千万不要被语法吓跑了,...在我心里,他是最好用的本地 markdown 编辑器,没有之一!在开发工具里面,它是除了 IDEA、chrome 之外,我使用率最高的一个 APP 了!...PlantUml 一共支持以下 UML 图:时序图、用例图、类图、对象图、活动图、组件图、部署图、状态图、定时图。 它的语法是非常容易上手的,基本上看过一遍 demo 就可以上手了!...相关教程可以在公众号后台回复关键字「uml」获取教程链接。 代码即格式的核心思想就是让我们在仅限的时间内,通过简单快速的指令,生成对应格式内容,而不用再花费精力在调整格式上面。

    55560

    markdown标记语言及其语法介绍

    而 Markdown 与此不同,当你创建 Markdown 格式的文件时,可以在文本中添加 Markdown 语法,以指示哪些单词和短语看起来应该有所不同。...如果你不喜欢当前使用的 Markdown 应用程序了,则可以将 Markdown 文件导入另一个 Markdown 应用程序中。...可以使用在线 Markdown 编辑器(opens new window)来编写 Markdown。进入其站点就可以开始在左侧窗格中书写了。渲染后的文档在右侧窗格预览。...Markdown 的工作原理 在使用 Markdown 格式书写时,文本内容存储在带有 .md 或 .markdown 扩展名的纯文本文件中。那然后呢?...像 在线 Markdown 编辑器 (opens new window)一样,它们都是将 Markdown 格式的文本转换为 HTML,以便可以在 Web 浏览器中显示。

    35810

    美哭了,一款面向程序员的 Markdown 笔记应用

    强大:支持版本控制;小程序、可运行代码块、表格、PlantUML、Drawio、宏替换等,都可以嵌入到文档中。...高兼容性:数据保存为本地 Markdown 文件,扩展功能尽量使用 Markdown 原语法实现。 插件扩展:支持用户编写自己的插件来扩展编辑器的功能。...支持加密:使用加密保存账号等私密文件,每个文件可以单独设置密码。 2 提醒 为了更具可扩展性,Yank Note 牺牲了安全保护(命令执行、任意文件读写)。...如果你想用它打开一个国外的 Markdown 文件,警告一定要仔细辨别文件内容是否可信警告。 加密文件的加解密都是在前端完成的。请务必记住您的密码。密码一旦丢失,只能暴力破解。...这个项目是开源的, 你也可以搭建在自己的本地,当然了,开发者也提供了全平台的工具包,大家可以自己下载使用,还可以在线体验。

    1.2K20

    欲善事先利器——系统篇

    语法高亮,列编辑,支持插件,行号显示,隐藏字符显示,文本查找替换(支持正则),文件编码修改等。 ScreenToGif 链接:https://www.screentogif.com/?...PlantUML 可以画几乎所有的 UML 图,不过我用它一般画的最多的是时序图 和流程图。最近发现其又增加了思维导图的特性,还兼容 Markdown 语法。...Typora Markdown 编辑器。 一个程序员必须要会写文档,有时候文档比代码重要。而写文档最推荐 Markdown 语法,首先语法简单,聪明的你们半小时入门,一天就可以六六六了。...其次很多博客和文档平台都支持 Markdown 语法,一招降龙十八掌打遍天下。 懂了 Markdown 语法,你还需要什么?没错,一款好用的 md 编辑器。...Typora 支持各种主题,支持即写即渲染,支持导出各种文件(我很多接口文档都是通过它导出的 pdf 给第三方)。 其他不多说,本文就是在 Typora 中完成的。

    79640

    分享几个我日常使用的VS Code插件

    这个扩展很不错,可以帮助我搞清楚 JavaScript 中复杂的嵌套 promise。顾名思义,它可以让方括号对变色,帮我弄清楚是否在某个地方搞糊涂了(例如缺少方括号)。...这可以提供很多帮助,尤其是当你的项目变得很大,并且在 package.json 中包含很多依赖项时。我不想再错过这个插件了,强烈推荐!...它们是 VS Code 的两个小插件,可通过自动重命名和关闭标签来帮助你维护 HTML 文件。这也适用于 React 自己的 JSX 语法。如果你想节省一些时间,请尝试一下。...我用 Markdown 做很多事情。例如,在 hashnode.com 或 dev.to 上写文章,为我的私人项目写文档,或者在 markdown 中写笔记来理顺自己的想法。...它不仅为你提供预览,而且还有同步滚动、PDF 导出和 PlantUML 的功能。我非常喜欢这个工具,所以向经常用 Markdown 的人们高度推荐。

    1.7K10

    这可能就是你苦苦寻找免费、高颜值、功能强大的 Markdown 编辑器(共5款)

    本文作者 | HelloGitHub-小猪蹄 作者博客 | https://chungzh.cn/ Markdown 是一个轻量级的标记语言,语法简单、容易上手,它深受程序员、博客主等人群的钟爱。...它有 Vim 模式和一系列强大的快捷键、可以直接从剪切板插入图片、支持 Mermaid[3]、 Flowchart.js[4]、 MathJax[5]、 PlantUML[6] 和 Graphviz[7...它与 VS Code 编辑器相同,因此内置了多光标、小地图和漂亮的语法高亮等功能。它采用分栏设计,同时还可以导入 Evernote 笔记。...采用分栏式预览,你可以根据自己的喜好对它的缩进、字体、样式以及 UI 语言进行自定义。...你在 simplenote 上写的笔记会在所有设备上同步更新,同时它还支持多人协作编辑文档。 最后 以上就是本期推荐的 5 款免费、开源的 Markdown 编辑器,是不是要颜有颜、要功能有功能呢?

    2.8K20

    使用PlantUML进行文本建模:实现可读的UML图模型与代码的整合

    然而,UML图的绘制、保存和共享往往需要专门的图形编辑工具,这可能会对团队的协作产生阻碍,特别是在分布式开发环境中。 PlantUML是一种开源工具,可以使用简单的、易读的文本描述来创建UML图。...这意味着你可以将UML图与源代码存储在同一版本控制系统中,而不需要处理二进制图形文件。这样不仅方便了版本管理,还能让开发者在编写和阅读代码的同时,理解其背后的设计思路。...-e[x]clude pattern:排除匹配提供的模式的文件。 -metadata:从PNG图像中检索PlantUML源文件。 -version:显示关于PlantUML和Java版本的信息。...-language:打印PlantUML关键词列表。 -checkonly:只检查文件的语法,不生成图像。 -failfast:一旦发生图表语法错误,就停止处理。...-htmlstats:在plantuml-stats.html文件中输出统计信息。 -xmlstats:在plantuml-stats.xml文件中输出统计信息。

    80540

    yank-note开源笔记工具

    是一款适合程序员的笔记工具,下载了看了一下还不错,可以替代typora,本小节做一个使用的梳理 特色 使用方便:使用 Monaco 内核,专为 Markdown 优化,拥有和 VSCode 一样的编辑体验...功能强大:支持历史版本回溯;可在文档中嵌入小工具、可运行的代码块、表格、PlantUML 图形、Drawio 图形、宏替换等;支持接入 OpenAI 自动补全。...兼容性强:数据保存为本地 Markdown 文件;拓展功能尽量用 Markdown 原有的语法实现。 插件拓展:支持用户编写自己的插件来拓展编辑器的功能。...可以设置仓库和自己的个人图床,在数据安全这方面还是非常不错的 使用过程 1 设置文件存储路径 在写文档的过程中如果需要保存自己的图床上,可以通过picgo来配置 如我用的是阿里云得oss只需要在上图的图床设置中来配置阿里云...oss的信息即可 使用小技巧 安装drawio插件后 然后创建drawio文件,然后通过链接地址到自己创建的drawio上 然后就可以在文档中引入drawio的内容 看看开发者怎么说

    85730
    领券