Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
Signed-off-by: Ryan Wang <[email protected]>
  • Loading branch information
ruibaby committed Jan 16, 2024
1 parent 91cb732 commit 6891605
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,35 @@
# plugin-text-diagram
# 文本绘图

为默认编辑器和文章渲染提供 文本绘图(mermaid) 支持。
为 Halo 2 的默认编辑器和文章渲染提供文本绘图(Mermaid & PlantUML)支持。

- [x] mermaid
- [x] plantuml
![Text Diagram](./images/plugin-text-diagram-screenshot.webp)

## 使用方式

1. 下载,目前提供以下两个下载方式:
- GitHub Releases:访问 [Releases](https://github.com/xinkeng0/plugin-text-diagram/releases) 下载 Assets 中的 JAR 文件。
- Halo 官方应用市场:<https://www.halo.run/store/apps/app-ahBRi>
2. 安装,插件安装和更新方式可参考:<https://docs.halo.run/user-guide/plugins>

## 用法说明

### 默认编辑器
增添了`/`快捷方式,文本绘图。

可以在指令菜单(/)中找到 **文本绘图** 菜单项,选择即可插入新的文本绘图块。

### 文章页渲染

此插件安装之后,支持渲染文本绘图。

配置项:

1. mermaid_selector

CSS-Selector语法,用来查找渲染的mermaid-Dom。

默认值为:`text-diagram[data-type="mermaid"]`(本插件扩展默认编辑器生成的行内公式Dom),如需兼容其他编辑器,则设置为相应的Selector即可(CSS-Selector支持或,`,`分隔即可)
CSS-Selector语法,用来查找渲染的mermaid-Dom。

默认值为:`text-diagram[data-type="mermaid"]`(本插件扩展默认编辑器生成的行内公式Dom),如需兼容其他编辑器,则设置为相应的Selector即可(CSS-Selector支持或,`,`分隔即可)

example:`.class1,.class2`
example:`.class1,.class2`

## 开发环境

Expand Down
Binary file added images/plugin-text-diagram-screenshot.webp
Binary file not shown.

0 comments on commit 6891605

Please sign in to comment.