reorg documents

hizzgdev · Jul 16, 2024 · 25ff04e · 25ff04e
1 parent 773990d
commit 25ff04e
Show file tree

Hide file tree

Showing 83 changed files with 148 additions and 135 deletions.
diff --git a/_config.yml b/_config.yml
@@ -8,10 +8,17 @@ description: " "
 
 show_sidebar: true
 
-navigation:                # accepts {file, title, url, icon, sidebaricon}
-  - {url: "/", title: "About jsMind", icon: bolt}
-  - {url: "/docs/", title: "Documents", icon: book}
-  - {url: "https://github.com/hizzgdev/jsmind", title: "GitHub", icon: github}
+navigation:                # accepts {file, title, url, icon, sidebaricon, level}
+  - {url: "/", title: "About jsMind", icon: bolt, level: 1}
+  - {url: "/docs/zh/", title: "文档", icon: book, level: 1}
+  - {url: "/docs/zh/get-started", title: "快速上手", icon: book, level: 2}
+  - {url: "/docs/zh/options", title: "选项", icon: book, level: 2}
+  - {url: "/docs/zh/3.operation.html", title: "API", icon: book, level: 2}
+  - {url: "/docs/en/", title: "Document", icon: book, level: 1}
+  - {url: "/docs/en/get-started", title: "Get Started", icon: book, level: 2}
+  - {url: "/docs/en/options", title: "Options", icon: book, level: 2}
+  - {url: "/docs/en/3.operation.html", title: "API", icon: book, level: 2}
+  - {url: "https://github.com/hizzgdev/jsmind", title: "GitHub", icon: github, level: 1}
 
 stats:
   google: G-JL176YVWE0
diff --git a/docs2/en/advanced/appearance.md → docs/en/advanced/appearance.md b/docs2/en/advanced/appearance.md → docs/en/advanced/appearance.md
diff --git a/docs2/en/advanced/custom_style.md → docs/en/advanced/custom_style.md b/docs2/en/advanced/custom_style.md → docs/en/advanced/custom_style.md
diff --git a/docs2/en/advanced/layout.md → docs/en/advanced/layout.md b/docs2/en/advanced/layout.md → docs/en/advanced/layout.md
diff --git a/docs/en/advanced/plugin.md b/docs/en/advanced/plugin.md
@@ -0,0 +1 @@
+plugin
diff --git a/docs2/en/advanced/shortcut.md → docs/en/advanced/shortcut.md b/docs2/en/advanced/shortcut.md → docs/en/advanced/shortcut.md
diff --git a/docs2/en/get-started/cdn.md → docs/en/get-started/cdn.md b/docs2/en/get-started/cdn.md → docs/en/get-started/cdn.md
diff --git a/docs2/en/get-started/data-format.md → docs/en/get-started/data-format.md b/docs2/en/get-started/data-format.md → docs/en/get-started/data-format.md
diff --git a/docs2/en/get-started/index.md → docs/en/get-started/index.md b/docs2/en/get-started/index.md → docs/en/get-started/index.md
diff --git a/docs/en/index.md b/docs/en/index.md
@@ -1,32 +1,33 @@
-Table of Contents
-======
-
-* [Usage](1.usage.md)
-  * Basic Framework
-  * Data Format
-  * Themes
-  * Styles
-* [Options](2.options.md)
-  * Introduction
-  * Conventional Options
-  * Layout Options
-  * Shortcuts
-* [API / Operation](3.operation.md)
-  * Rendering a Mindmap
-  * Finding Nodes
-  * Operation on Nodes
-  * Editing Nodes
-  * Setting Style
-  * Access to Data
-  * Other Operations
-* [Experimental Features](experimental-features.md)
-  * [Screenshot (Export as Image)](plugin-screenshot.md)
-* [Contribution](4.contribution.md)
-* [Development Guide](5.development.md)
-
-copyright notice
-======
-
-Reproduction and deduction are prohibited.
-
-The jsMind project is still being updated and the corresponding documentation is updated at the same time as the version is updated. In order to avoid confusion to the user, it is forbidden to reprint this document without written permission and to make changes of any kind to this document.
+# Introduction to jsMind
+
+jsMind is a pure JavaScript library for displaying and editing mind maps. It is designed based on Canvas and SVG technologies, allowing it to run efficiently in modern browsers. jsMind is open-sourced under the BSD license, which means it can be embedded in any project as long as the license is followed.
+
+## Features
+
+### Main Features
+jsMind provides powerful mind map editing features, supporting operations such as adding, deleting, and moving nodes. It comes with many built-in themes, allowing users to choose the appropriate theme or customize their own. Additionally, the styles of nodes can be customized through CSS, including background color, font color, hover effects, etc. jsMind also offers a rich set of APIs, making it easy for developers to perform secondary development and feature extensions.
+
+### Characteristics
+- **Simple**: jsMind is very easy to use, requiring only a few lines of code to create a mind map.
+- **Fast**: Based on HTML5 technology, jsMind runs very fast in modern browsers.
+- **Rich Interface**: It provides a rich set of APIs, making it convenient for developers to perform various operations.
+- **Open Source**: jsMind is open-sourced under the BSD license, with transparent code and an active community.
+- **Commercial-Friendly**: The BSD license allows free use in commercial projects.
+- **Customizable**: Through CSS and JavaScript, jsMind can be highly customized to meet various needs.
+
+## Use Cases
+
+jsMind is suitable for various scenarios that require visualizing mind maps, such as:
+- **Project Management**: To display the task breakdown structure of a project, helping team members better understand project progress and task allocation.
+- **Knowledge Management**: To organize and display the relationships between knowledge points, helping users better organize and memorize knowledge.
+- **Brainstorming**: To record and organize the results of brainstorming sessions, helping team members better organize ideas and creativity.
+- **Study Notes**: To record study notes and mind maps, helping students better understand and memorize study content.
+- **Meeting Minutes**: To record meeting content and discussion results, helping team members better review and follow up on meeting decisions.
+
+## Screenshot
+
+Below is an example screenshot of jsMind:
+
+![jsMind Example](https://hizzgdev.github.io/jsmind/screenshots/jsmind.png)
+
+The screenshot comes from [jsMind Online App](https://jsmind.online).
diff --git a/docs/en/index2.md b/docs/en/index2.md
@@ -0,0 +1,32 @@
+Table of Contents
+======
+
+* [Usage](1.usage.md)
+  * Basic Framework
+  * Data Format
+  * Themes
+  * Styles
+* [Options](2.options.md)
+  * Introduction
+  * Conventional Options
+  * Layout Options
+  * Shortcuts
+* [API / Operation](3.operation.md)
+  * Rendering a Mindmap
+  * Finding Nodes
+  * Operation on Nodes
+  * Editing Nodes
+  * Setting Style
+  * Access to Data
+  * Other Operations
+* [Experimental Features](experimental-features.md)
+  * [Screenshot (Export as Image)](plugin-screenshot.md)
+* [Contribution](4.contribution.md)
+* [Development Guide](5.development.md)
+
+copyright notice
+======
+
+Reproduction and deduction are prohibited.
+
+The jsMind project is still being updated and the corresponding documentation is updated at the same time as the version is updated. In order to avoid confusion to the user, it is forbidden to reprint this document without written permission and to make changes of any kind to this document.
diff --git a/docs2/en/options/index.md → docs/en/options/index.md b/docs2/en/options/index.md → docs/en/options/index.md
diff --git a/docs2/en/options/option.container.md → docs/en/options/option.container.md b/docs2/en/options/option.container.md → docs/en/options/option.container.md
diff --git a/docs2/en/options/option.editable.md → docs/en/options/option.editable.md b/docs2/en/options/option.editable.md → docs/en/options/option.editable.md
diff --git a/.../en/options/option.layout.cousin_space.md → .../en/options/option.layout.cousin_space.md b/.../en/options/option.layout.cousin_space.md → .../en/options/option.layout.cousin_space.md
diff --git a/docs2/en/options/option.layout.hspace.md → docs/en/options/option.layout.hspace.md b/docs2/en/options/option.layout.hspace.md → docs/en/options/option.layout.hspace.md
diff --git a/docs2/en/options/option.layout.pspace.md → docs/en/options/option.layout.pspace.md b/docs2/en/options/option.layout.pspace.md → docs/en/options/option.layout.pspace.md
diff --git a/docs2/en/options/option.layout.vspace.md → docs/en/options/option.layout.vspace.md b/docs2/en/options/option.layout.vspace.md → docs/en/options/option.layout.vspace.md
diff --git a/docs2/en/options/option.log_level.md → docs/en/options/option.log_level.md b/docs2/en/options/option.log_level.md → docs/en/options/option.log_level.md
diff --git a/docs2/en/options/option.mode.md → docs/en/options/option.mode.md b/docs2/en/options/option.mode.md → docs/en/options/option.mode.md
diff --git a/docs/en/options/option.plugin.md b/docs/en/options/option.plugin.md
@@ -0,0 +1 @@
+plugin option
diff --git a/docs2/en/options/option.shortcut.enable.md → docs/en/options/option.shortcut.enable.md b/docs2/en/options/option.shortcut.enable.md → docs/en/options/option.shortcut.enable.md
diff --git a/docs2/en/options/option.shortcut.handles.md → docs/en/options/option.shortcut.handles.md b/docs2/en/options/option.shortcut.handles.md → docs/en/options/option.shortcut.handles.md
diff --git a/docs2/en/options/option.shortcut.mapping.md → docs/en/options/option.shortcut.mapping.md b/docs2/en/options/option.shortcut.mapping.md → docs/en/options/option.shortcut.mapping.md
diff --git a/docs2/en/options/option.support_html.md → docs/en/options/option.support_html.md b/docs2/en/options/option.support_html.md → docs/en/options/option.support_html.md
diff --git a/docs2/en/options/option.theme.md → docs/en/options/option.theme.md b/docs2/en/options/option.theme.md → docs/en/options/option.theme.md
diff --git a/...options/option.view.custom_line_render.md → ...options/option.view.custom_line_render.md b/...options/option.view.custom_line_render.md → ...options/option.view.custom_line_render.md
diff --git a/...options/option.view.custom_node_render.md → ...options/option.view.custom_node_render.md b/...options/option.view.custom_node_render.md → ...options/option.view.custom_node_render.md
diff --git a/docs2/en/options/option.view.draggable.md → docs/en/options/option.view.draggable.md b/docs2/en/options/option.view.draggable.md → docs/en/options/option.view.draggable.md
diff --git a/.../option.view.enable_device_pixel_ratio.md → .../option.view.enable_device_pixel_ratio.md b/.../option.view.enable_device_pixel_ratio.md → .../option.view.enable_device_pixel_ratio.md
diff --git a/docs2/en/options/option.view.engine.md → docs/en/options/option.view.engine.md b/docs2/en/options/option.view.engine.md → docs/en/options/option.view.engine.md
diff --git a/.../en/options/option.view.expander_style.md → .../en/options/option.view.expander_style.md b/.../en/options/option.view.expander_style.md → .../en/options/option.view.expander_style.md
diff --git a/...on.view.hide_scrollbars_when_draggable.md → ...on.view.hide_scrollbars_when_draggable.md b/...on.view.hide_scrollbars_when_draggable.md → ...on.view.hide_scrollbars_when_draggable.md
diff --git a/...en/options/option.view.hmargin.vmargin.md → ...en/options/option.view.hmargin.vmargin.md b/...en/options/option.view.hmargin.vmargin.md → ...en/options/option.view.hmargin.vmargin.md
diff --git a/docs2/en/options/option.view.line_color.md → docs/en/options/option.view.line_color.md b/docs2/en/options/option.view.line_color.md → docs/en/options/option.view.line_color.md
diff --git a/docs2/en/options/option.view.line_style.md → docs/en/options/option.view.line_style.md b/docs2/en/options/option.view.line_style.md → docs/en/options/option.view.line_style.md
diff --git a/docs2/en/options/option.view.line_width.md → docs/en/options/option.view.line_width.md b/docs2/en/options/option.view.line_width.md → docs/en/options/option.view.line_width.md
diff --git a/...2/en/options/option.view.node_overflow.md → docs/en/options/option.view.node_overflow.md b/...2/en/options/option.view.node_overflow.md → docs/en/options/option.view.node_overflow.md
diff --git a/docs2/en/options/option.view.zoom.md → docs/en/options/option.view.zoom.md b/docs2/en/options/option.view.zoom.md → docs/en/options/option.view.zoom.md
diff --git a/docs/en/plugins/plugin.draggable-node.md b/docs/en/plugins/plugin.draggable-node.md
@@ -0,0 +1 @@
+draggable-node plugin
diff --git a/docs2/index.md → docs/outline.md b/docs2/index.md → docs/outline.md
diff --git a/docs2/zh/advanced/appearance.md → docs/zh/advanced/appearance.md b/docs2/zh/advanced/appearance.md → docs/zh/advanced/appearance.md
diff --git a/docs2/zh/advanced/custom_style.md → docs/zh/advanced/custom_style.md b/docs2/zh/advanced/custom_style.md → docs/zh/advanced/custom_style.md
diff --git a/docs2/zh/advanced/layout.md → docs/zh/advanced/layout.md b/docs2/zh/advanced/layout.md → docs/zh/advanced/layout.md
diff --git a/docs/zh/advanced/plugin.md b/docs/zh/advanced/plugin.md
@@ -0,0 +1 @@
+plugin
diff --git a/docs2/zh/advanced/shortcut.md → docs/zh/advanced/shortcut.md b/docs2/zh/advanced/shortcut.md → docs/zh/advanced/shortcut.md
diff --git a/docs/zh/api/jsMind.md b/docs/zh/api/jsMind.md
diff --git a/docs2/zh/get-started/cdn.md → docs/zh/get-started/cdn.md b/docs2/zh/get-started/cdn.md → docs/zh/get-started/cdn.md
diff --git a/docs2/zh/get-started/data-format.md → docs/zh/get-started/data-format.md b/docs2/zh/get-started/data-format.md → docs/zh/get-started/data-format.md
diff --git a/docs2/zh/get-started/index.md → docs/zh/get-started/index.md b/docs2/zh/get-started/index.md → docs/zh/get-started/index.md
diff --git a/docs/zh/index.md b/docs/zh/index.md
@@ -1,32 +1,34 @@
-目录
-======
-
-* [基本用法](1.usage.md)
-  * 基本框架
-  * 数据格式
-  * 主题
-  * 样式
-* [选项](2.options.md)
-  * 综述
-  * 常规选项
-  * 布局选项
-  * 快捷键
-* [界面操控](3.operation.md)
-  * 显示思维导图
-  * 查找节点
-  * 操作节点
-  * 编辑节点
-  * 设置样式
-  * 获取数据
-  * 其它操作
-* [实验性功能](experimental-features.md)
-  * [截图 (导出图片)](plugin-screenshot.md)
-* [参与贡献](4.contribution.md)
-* [贡献代码指南](5.development.md)
-
-版权声明
-======
-
-禁止转载、禁止演绎。
-
-jsMind 项目仍在不断升级变化，版本更新时会同时更新对应的文档。为避免给使用者带来困惑，在没有得到书面许可前，禁止转载本文档，同时禁止对本文档进行任何形式的更改。
+# jsMind 简介
+
+jsMind 是一个用于显示和编辑思维导图的纯 JavaScript 类库。它基于 Canvas 和 SVG 进行设计，能够在现代浏览器中高效地运行。jsMind 以 BSD 协议开源，这意味着可以在遵守该协议的前提下，将其嵌入到任何项目中使用。
+
+## 功能特点
+
+### 主要功能
+jsMind 提供了强大的脑图编辑功能，支持节点的添加、删除、移动等操作。它内置了多种主题，用户可以根据需要选择合适的主题，或者自定义主题。此外，通过 CSS 可以自定义节点的样式，包括背景色、字体颜色、鼠标悬停效果等。jsMind 还提供了丰富的 API，方便开发者进行二次开发和功能扩展。
+
+### 特点
+- **简单**：jsMind 的使用非常简单，只需几行代码即可创建一个思维导图。
+- **快速**：基于 HTML5 技术，jsMind 在现代浏览器中运行速度非常快。
+- **接口丰富**：提供了丰富的 API，方便开发者进行各种操作。
+- **开源**：jsMind 以 BSD 协议开源，代码透明，社区活跃。
+- **商业友好**：BSD 协议允许在商业项目中免费使用。
+- **可定制**：通过 CSS 和 JavaScript，可以对 jsMind 进行高度定制，满足各种需求。
+
+## 使用场景
+
+jsMind 适用于各种需要可视化思维导图的场景，例如：
+- **项目管理**：用于展示项目的任务分解结构，帮助团队成员更好地理解项目进展和任务分配。
+- **知识管理**：用于整理和展示知识点之间的关系，帮助用户更好地组织和记忆知识。
+- **头脑风暴**：用于记录和组织头脑风暴的结果，帮助团队成员更好地整理思路和创意。
+- **学习笔记**：用于记录学习过程中的笔记和思维导图，帮助学生更好地理解和记忆学习内容。
+- **会议记录**：用于记录会议内容和讨论结果，帮助团队成员更好地回顾和跟进会议决策。
+
+## 效果图
+
+以下是一个 jsMind 的效果图示例：
+
+![jsMind 示例](https://hizzgdev.github.io/jsmind/screenshots/jsmind.png)
+
+截图来自 [jsMind 在线应用](https://jsmind.online)。
+
diff --git a/docs/zh/index2.md b/docs/zh/index2.md
@@ -0,0 +1,32 @@
+目录
+======
+
+* [基本用法](1.usage.md)
+  * 基本框架
+  * 数据格式
+  * 主题
+  * 样式
+* [选项](2.options.md)
+  * 综述
+  * 常规选项
+  * 布局选项
+  * 快捷键
+* [界面操控](3.operation.md)
+  * 显示思维导图
+  * 查找节点
+  * 操作节点
+  * 编辑节点
+  * 设置样式
+  * 获取数据
+  * 其它操作
+* [实验性功能](experimental-features.md)
+  * [截图 (导出图片)](plugin-screenshot.md)
+* [参与贡献](4.contribution.md)
+* [贡献代码指南](5.development.md)
+
+版权声明
+======
+
+禁止转载、禁止演绎。
+
+jsMind 项目仍在不断升级变化，版本更新时会同时更新对应的文档。为避免给使用者带来困惑，在没有得到书面许可前，禁止转载本文档，同时禁止对本文档进行任何形式的更改。
diff --git a/docs2/zh/options/index.md → docs/zh/options/index.md b/docs2/zh/options/index.md → docs/zh/options/index.md
diff --git a/docs2/zh/options/option.container.md → docs/zh/options/option.container.md b/docs2/zh/options/option.container.md → docs/zh/options/option.container.md
diff --git a/docs2/zh/options/option.editable.md → docs/zh/options/option.editable.md b/docs2/zh/options/option.editable.md → docs/zh/options/option.editable.md
diff --git a/.../zh/options/option.layout.cousin_space.md → .../zh/options/option.layout.cousin_space.md b/.../zh/options/option.layout.cousin_space.md → .../zh/options/option.layout.cousin_space.md
diff --git a/docs2/zh/options/option.layout.hspace.md → docs/zh/options/option.layout.hspace.md b/docs2/zh/options/option.layout.hspace.md → docs/zh/options/option.layout.hspace.md
diff --git a/docs2/zh/options/option.layout.pspace.md → docs/zh/options/option.layout.pspace.md b/docs2/zh/options/option.layout.pspace.md → docs/zh/options/option.layout.pspace.md
diff --git a/docs2/zh/options/option.layout.vspace.md → docs/zh/options/option.layout.vspace.md b/docs2/zh/options/option.layout.vspace.md → docs/zh/options/option.layout.vspace.md
diff --git a/docs2/zh/options/option.log_level.md → docs/zh/options/option.log_level.md b/docs2/zh/options/option.log_level.md → docs/zh/options/option.log_level.md
diff --git a/docs2/zh/options/option.mode.md → docs/zh/options/option.mode.md b/docs2/zh/options/option.mode.md → docs/zh/options/option.mode.md
diff --git a/docs/zh/options/option.plugin.md b/docs/zh/options/option.plugin.md
@@ -0,0 +1 @@
+plugin option
diff --git a/docs2/zh/options/option.shortcut.enable.md → docs/zh/options/option.shortcut.enable.md b/docs2/zh/options/option.shortcut.enable.md → docs/zh/options/option.shortcut.enable.md
diff --git a/docs2/zh/options/option.shortcut.handles.md → docs/zh/options/option.shortcut.handles.md b/docs2/zh/options/option.shortcut.handles.md → docs/zh/options/option.shortcut.handles.md
diff --git a/docs2/zh/options/option.shortcut.mapping.md → docs/zh/options/option.shortcut.mapping.md b/docs2/zh/options/option.shortcut.mapping.md → docs/zh/options/option.shortcut.mapping.md
diff --git a/docs2/zh/options/option.support_html.md → docs/zh/options/option.support_html.md b/docs2/zh/options/option.support_html.md → docs/zh/options/option.support_html.md
diff --git a/docs2/zh/options/option.theme.md → docs/zh/options/option.theme.md b/docs2/zh/options/option.theme.md → docs/zh/options/option.theme.md
diff --git a/...options/option.view.custom_line_render.md → ...options/option.view.custom_line_render.md b/...options/option.view.custom_line_render.md → ...options/option.view.custom_line_render.md
diff --git a/...options/option.view.custom_node_render.md → ...options/option.view.custom_node_render.md b/...options/option.view.custom_node_render.md → ...options/option.view.custom_node_render.md
diff --git a/docs2/zh/options/option.view.draggable.md → docs/zh/options/option.view.draggable.md b/docs2/zh/options/option.view.draggable.md → docs/zh/options/option.view.draggable.md
diff --git a/.../option.view.enable_device_pixel_ratio.md → .../option.view.enable_device_pixel_ratio.md b/.../option.view.enable_device_pixel_ratio.md → .../option.view.enable_device_pixel_ratio.md
diff --git a/docs2/zh/options/option.view.engine.md → docs/zh/options/option.view.engine.md b/docs2/zh/options/option.view.engine.md → docs/zh/options/option.view.engine.md
diff --git a/.../zh/options/option.view.expander_style.md → .../zh/options/option.view.expander_style.md b/.../zh/options/option.view.expander_style.md → .../zh/options/option.view.expander_style.md
diff --git a/...on.view.hide_scrollbars_when_draggable.md → ...on.view.hide_scrollbars_when_draggable.md b/...on.view.hide_scrollbars_when_draggable.md → ...on.view.hide_scrollbars_when_draggable.md
diff --git a/...zh/options/option.view.hmargin.vmargin.md → ...zh/options/option.view.hmargin.vmargin.md b/...zh/options/option.view.hmargin.vmargin.md → ...zh/options/option.view.hmargin.vmargin.md
diff --git a/docs2/zh/options/option.view.line_color.md → docs/zh/options/option.view.line_color.md b/docs2/zh/options/option.view.line_color.md → docs/zh/options/option.view.line_color.md
diff --git a/docs2/zh/options/option.view.line_style.md → docs/zh/options/option.view.line_style.md b/docs2/zh/options/option.view.line_style.md → docs/zh/options/option.view.line_style.md
diff --git a/docs2/zh/options/option.view.line_width.md → docs/zh/options/option.view.line_width.md b/docs2/zh/options/option.view.line_width.md → docs/zh/options/option.view.line_width.md
diff --git a/...2/zh/options/option.view.node_overflow.md → docs/zh/options/option.view.node_overflow.md b/...2/zh/options/option.view.node_overflow.md → docs/zh/options/option.view.node_overflow.md
diff --git a/docs2/zh/options/option.view.zoom.md → docs/zh/options/option.view.zoom.md b/docs2/zh/options/option.view.zoom.md → docs/zh/options/option.view.zoom.md
diff --git a/docs/zh/plugins/plugin.draggable-node.md b/docs/zh/plugins/plugin.draggable-node.md
@@ -0,0 +1 @@
+draggable-node plugin
diff --git a/docs2/en/index.md b/docs2/en/index.md
diff --git a/docs2/zh/index.md b/docs2/zh/index.md