Skip to content

Commit

Permalink
docs: update PlantUML
Browse files Browse the repository at this point in the history
  • Loading branch information
purocean committed Mar 12, 2022
1 parent 235e3d7 commit 9e0c768
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 11 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ English | [中文说明](./README_ZH-CN.md)
## Highlights

- **Easy to use:** Use *Monaco* kernel, optimize for Markdown editing, and have the same editing experience as VSCode.
- **Powerful:** Support version control; Applets, runnable code blocks, tables, Plantuml, Drawio, macro replacements, etc., can be embedded in the document.
- **Powerful:** Support version control; Applets, runnable code blocks, tables, PlantUML, Drawio, macro replacements, etc., can be embedded in the document.
- **High compatibility:** Data is saved as local Markdown files, and the extension functions are implemented in the original syntax of Markdown as far as possible.
- **Plug-in extension:** Support users to write their own plug-ins to expand the functionality of the editor.
- **Encryption supported:** Use encryption to save private files such as account number, and the password can be set separately for each file.
Expand Down Expand Up @@ -65,7 +65,7 @@ For more information on how to use the following functions, please see [characte
- **Edit table cell:** double-click a table cell to quickly edit
- **Copy title link:** copy title link path to the clipboard for easy insertion into other files
- **Embedded Applets:** document supports embedded HTML Applets
- **Embed Plantuml graphics:** you need to install Java and graphviz
- **Embed PlantUML graphics:** document supports embedded plantUML graphics
- **Embed drawio graphics:** document supports embedded drawio graphics
- **Embed ECharts graphics:** document supports embeded Echarts graphics
- **Embed Mermaid graphics:** document supports embeded Mermaid graphics
Expand Down
6 changes: 3 additions & 3 deletions README_ZH-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
## 特色

- **使用方便**:使用 Monaco 内核,专为 Markdown 优化,拥有和 VSCode 一样的编辑体验。
- **功能强大**:支持历史版本回溯;可在文档中嵌入小工具、可运行的代码块、表格、Plantuml 图形、Drawio 图形、宏替换等。
- **功能强大**:支持历史版本回溯;可在文档中嵌入小工具、可运行的代码块、表格、PlantUML 图形、Drawio 图形、宏替换等。
- **兼容性强**:数据保存为本地 Markdown 文件;拓展功能尽量用 Markdown 原有的语法实现。
- **插件拓展**:支持用户编写自己的插件来拓展编辑器的功能。
- **支持加密**:用来保存账号等隐私文件,文件可单独设置密码。
Expand Down Expand Up @@ -65,8 +65,8 @@ V3 核心目标是重构代码,提升应用健壮性、可拓展性、Markdown
- **编辑表格单元格:** 双击表格单元格即可快速编辑
- **复制标题链接:** 复制标题链接路径到剪切板,便于插入到其他文件
- **嵌入小工具:** 文档支持内嵌 HTML 小工具
- **嵌入 Plantuml 图形:** 需要安装 Java,graphviz
- **嵌入 drawio 图形:** 文档支持内嵌 drawio 图形
- **嵌入 PlantUML 图形:** 在文档内内嵌 PlantUML 图形
- **嵌入 drawio 图形:** 在文档中内嵌 drawio 图形
- **嵌入 ECharts 图形:** 在文档中嵌入 Echarts 图形
- **嵌入 Mermaid 图形:** 在文档中嵌入 Mermaid 图形
- **嵌入 Luckysheet 表格:** 在文档中嵌入 Luckysheet 表格
Expand Down
8 changes: 4 additions & 4 deletions help/FEATURES.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,13 +165,13 @@ journey
Sit down: 3: Me
```

## Plantuml
## PlantUML


If you are configured to use local endpoint in the Setting, the system needs to have a Java environment with Graphviz installed.
You can configure the use of local endpoint or PlantUML online endpoint to generate graph in Settings.

::: warning
if it prompts an error `Cannot find Graphviz`,
If you are use local endpoint, the system needs to have a Java environment with Graphviz installed.
If it prompts an error `Cannot find Graphviz`,
Please refer to [Test your GraphViz installation](https://plantuml.com/graphviz-dot)
:::

Expand Down
5 changes: 3 additions & 2 deletions help/FEATURES_ZH-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,11 +167,12 @@ journey
Sit down: 3: Me
```

## Plantuml 图形
## PlantUML 图形

如果在配置中选择使用本地端点,则系统需要有 Java 环境,并安装有 Graphviz
您可以在“设置”中配置使用本地端点或 PlantUML 在线端点来生成图形。

::: warning
如果使用本地端点,则系统需要有 Java 环境,并安装有 Graphviz
如果提示 `Cannot find Graphviz`,请参考 [Test your GraphViz installation](https://plantuml.com/graphviz-dot)
:::

Expand Down

0 comments on commit 9e0c768

Please sign in to comment.