Skip to content

Commit 4f3f171

Browse files
committed
docs: update README files to include online usage information for MarkXMind
- Added a section highlighting the online editor capabilities of MarkXMind in both English and Chinese README files. - Included links for users to try the online editor and access additional features.
1 parent 6aa77df commit 4f3f171

2 files changed

Lines changed: 8 additions & 2 deletions

File tree

packages/markxmind-core/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@
77

88
MarkXMind parser — turn Markdown-like text into XMind mind map data.
99

10+
> 🎉 **Use MarkXMind online**
11+
>
12+
> [**MarkXMind**](https://github.com/jinzcdev/markxmind) is an online editor that builds mind maps from XMindMark syntax. It offers real-time preview, export to .xmind / .svg / .png, and import of existing XMind files. [**Try it now**](https://markxmind.js.org/)
13+
1014
## ⚙️ Requirements
1115

1216
- **Node.js** ≥ 18 (when used in Node).
@@ -70,7 +74,6 @@ import type {
7074

7175
- **Web editors** — Live preview of MarkXMind text.
7276
- **CLI tools** — Convert between `.xmind` and `.xmindmark` on the command line.
73-
- **Custom renderers** — Feed `SheetModel` into any renderer (e.g. Snowbrush, Canvas, SVG).
7477

7578
## 📄 License
7679

packages/markxmind-core/README_zh-CN.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@
77

88
MarkXMind 解析核心库 —— 将类 Markdown 语法的文本解析为 XMind 思维导图数据结构。
99

10+
> 🎉 **在线使用 MarkXMind**
11+
>
12+
> [**MarkXMind**](https://github.com/jinzcdev/markxmind) 是基于本库的在线编辑器:用 XMindMark 语法编写即可生成思维导图,支持实时预览、导出 .xmind / .svg / .png,以及导入已有 XMind 文件。[**立即体验**](https://markxmind.js.org/)
13+
1014
## ⚙️ 环境要求
1115

1216
- **Node.js** ≥ 18(在 Node 中使用时)。
@@ -70,7 +74,6 @@ import type {
7074

7175
- **Web 编辑器**:实时预览 MarkXMind 文本。
7276
- **CLI 工具**:在命令行中转换 .xmind ↔ .xmindmark。
73-
- **自定义渲染**:将 `SheetModel` 传入任意渲染库(如 Snowbrush、Canvas、SVG)。
7477

7578
## 📄 许可证
7679

0 commit comments

Comments
 (0)