Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hizzgdev committed Jul 16, 2024
1 parent 07bfaff commit c681871
Show file tree
Hide file tree
Showing 19 changed files with 34 additions and 296 deletions.
25 changes: 4 additions & 21 deletions docs/en/1.usage.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@
[Table of Contents](index.md)

* [Usage *](1.usage.md)
* [Options](2.options.md)
* [Operation](3.operation.md)
* [Experimental Features](experimental-features.md)
* [Screenshot (Export as Image)](plugin-screenshot.md)
* [Contribution](4.contribution.md)
* [Development Guide](5.development.md)

1.1. Basic Framework
Basic Framework
===

At first, 2 files (jsmind.css and jsmind.js) are required. Here we link to the resources on the CDN. It is recommended to use the latest version.
Expand Down Expand Up @@ -68,7 +58,7 @@ Or, show a mindmap with some topics:
</script>
```

1.2. Data Format
Data Format
===

3 formats are supported by jsMind: `node_tree`,`node_array` and `freemind`. jsMind can load mind maps in these formats, and can also export data to any of these formats.
Expand Down Expand Up @@ -154,7 +144,7 @@ var mind = {
};
```

1.3. Themes
Themes
===

15 themes were supported in jsmind, you can preview those themes by visiting [feature-demo](http://hizzgdev.github.io/jsmind/example/2_features.html).
Expand Down Expand Up @@ -187,7 +177,7 @@ jmnodes.theme-greensea jmexpander{}
jmnodes.theme-greensea jmexpander:hover{}
```

1.4. Styles
Styles
===

In addition to the Themes, there are some styles can be set at node level:
Expand Down Expand Up @@ -234,10 +224,3 @@ var mind = {
...
}
```
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.
26 changes: 4 additions & 22 deletions docs/en/2.options.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,4 @@
[Table of Contents](index.md)

* [Usage](1.usage.md)
* [Options *](2.options.md)
* [Operation](3.operation.md)
* [Experimental Features](experimental-features.md)
* [Screenshot (Export as Image)](plugin-screenshot.md)
* [Contribution](4.contribution.md)
* [Development Guide](5.development.md)


2.1. Introduction
Overall
===

The options object for jsMind was briefly mentioned in the example in the previous chapter:
Expand Down Expand Up @@ -74,7 +63,7 @@ Except the container, there are all optional.

These options are described in more detail below.

2.2 Conventional Options
Conventional Options
===

**container** : (string) [required] ID of the container
Expand Down Expand Up @@ -112,7 +101,7 @@ These options are described in more detail below.

> There are 5 levels: `debug`/`info`/`warn`/`error`/`disable`, default level is `info`. if it set to `disable`, all the logs will be closed.
2.3 Layout Options
Layout Options
===

**view.engine** : (string) engine for drawing lines between nodes in a mindmap
Expand Down Expand Up @@ -189,7 +178,7 @@ These options are described in more detail below.

> The default value is 0, which means no additional vertical spacing
2.4. Shortcuts
Shortcuts
===

**shortcut.enable** : (bool) Whether to enable shortcut keys
Expand Down Expand Up @@ -252,11 +241,4 @@ mapping:{
}
```

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.

[1]:http://www.nowamagic.net/librarys/veda/detail/1190 "CSS Block Level Element, Inline Element Concept"
32 changes: 7 additions & 25 deletions docs/en/3.operation.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,3 @@
[Table of Contents](index.md)

* [Usage](1.usage.md)
* [Options](2.options.md)
* [Operation *](3.operation.md)
* [Experimental Features](experimental-features.md)
* [Screenshot (Export as Image)](plugin-screenshot.md)
* [Contribution](4.contribution.md)
* [Development Guide](5.development.md)


jsMind object
===

Expand Down Expand Up @@ -48,12 +37,12 @@ node {
}
```

3.1 Displaying a mindmap
Displaying a mindmap
===

Use the `jm.show(mind)` method to display a mindmap, see [1.1. Basic framework](1.usage.md) for specific usage.

3.2. Finding Nodes
Finding Nodes
===

**Get root** : Use `jm.get_root()` to get the root of the current mindmap.
Expand All @@ -68,7 +57,7 @@ Use the `jm.show(mind)` method to display a mindmap, see [1.1. Basic framework](

**Fetching a collection of child nodes** : A collection of child nodes can be obtained using `node.children`.

3.3 Operation on Nodes
Operation on Nodes
===

**Select node** : Use the `jm.select_node(node)` method to select the specified node.
Expand Down Expand Up @@ -109,7 +98,7 @@ Use the `jm.show(mind)` method to display a mindmap, see [1.1. Basic framework](
**Stop editing** : The node can be adjusted to read-only using the `jm.end_edit()` method.


3.4. Editing Nodes
Editing Nodes
===

**Add Node** : Use the `jm.add_node(parent_node, node_id, topic, data, direction)` method to add a sub node to the `parent_node`. `data` and `direction` are optional.
Expand All @@ -123,7 +112,7 @@ Use the `jm.show(mind)` method to display a mindmap, see [1.1. Basic framework](
**Update node** : Use the `jm.update_node(node_id, topic)` method to update the topic of the specified node.


3.5 Setting Style
Setting Style
===

**Set the theme** : Use the `jm.set_theme(theme)` method to set the theme of the mind map.
Expand All @@ -134,23 +123,16 @@ Use the `jm.show(mind)` method to display a mindmap, see [1.1. Basic framework](

**Set background image** : Use the `jm.set_node_background_image(node_id, image, width, height)` method to set the background image of the specified node.

3.6 Access to Data
Access to Data
===

**Get metadata** : Use the `jm.get_meta()` method to get metadata for the current mindmap.

**Get Data** : Use the `jm.get_data(data_format)` method to get the data text in the specified format of the current mindmap.

3.7 Other Operations
Other Operations
===

**Clear selection of nodes** : Use the `jm.select_clear()` method to clear the current selected state.

**Determine if the node is visible** : Use the `jm.is_node_visible(node)` method to determine if this node is visible.

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.
17 changes: 0 additions & 17 deletions docs/en/4.contribution.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,3 @@
[Table of Contents](index.md)

* [Usage](1.usage.md)
* [Options](2.options.md)
* [Operation](3.operation.md)
* [Experimental Features](experimental-features.md)
* [Screenshot (Export as Image)](plugin-screenshot.md)
* [Contribution *](4.contribution.md)
* [Development Guide](5.development.md)

Contribution code
===

Expand All @@ -31,10 +21,3 @@ Customization
===

JsMind is an open source library with the BSD license, and can be used in commercial production. If there is a need for customization, please contact the author or other developers you trust.

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.
19 changes: 0 additions & 19 deletions docs/en/5.development.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,3 @@
[Table of Contents](index.md)

* [Usage](1.usage.md)
* [Options](2.options.md)
* [Operation](3.operation.md)
* [Experimental Features](experimental-features.md)
* [Screenshot (Export as Image)](plugin-screenshot.md)
* [Contribution](4.contribution.md)
* [Development Guide *](5.development.md)


> First of all, I would like to express my gratitude to you. The open source community is thriving because of you, and jsMind has gained even greater value because of you.
Contributing process
Expand Down Expand Up @@ -78,11 +67,3 @@ The accessible url will be printed in the command line window, which probably be
it is strongly recommended to test all the use cases on the page, no matter you are developing a new feature or fixing a bug.

It should be noted: If the ES6 files is changed, you may have to run `npm run build` and refresh the page to preview the changes.


copyright
===

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.
17 changes: 0 additions & 17 deletions docs/en/experimental-features.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,3 @@
[Table of Contents](index.md)

* [Usage](1.usage.md)
* [Options](2.options.md)
* [Operation](3.operation.md)
* [Experimental Features *](experimental-features.md)
* [Screenshot (Export as Image)](plugin-screenshot.md)
* [Contribution](4.contribution.md)
* [Development Guide](5.development.md)

Experimental Features
===

Expand All @@ -18,10 +8,3 @@ List of Experimental Features:

- [Screenshot (Export as Image)](plugin-screenshot.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.
7 changes: 0 additions & 7 deletions docs/en/index-legacy.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,3 @@ Table of Contents
* [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.
2 changes: 1 addition & 1 deletion docs/en/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Introduction to jsMind
# 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.

Expand Down
2 changes: 1 addition & 1 deletion docs/en/options/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# jsMind Supported Options
# Options

jsMind provides various options to customize the behavior and appearance of mind maps.

Expand Down
17 changes: 0 additions & 17 deletions docs/en/plugin-screenshot.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,3 @@
[Table of Contents](index.md)

* [Usage](1.usage.md)
* [Options](2.options.md)
* [Operation](3.operation.md)
* [Experimental Features](experimental-features.md)
* [Screenshot (Export as Image) *](plugin-screenshot.md)
* [Contribution](4.contribution.md)
* [Development Guide](5.development.md)

Screenshot (Export as Image) <sup>[experimental](experimental-features.md)</sup>
===

Expand Down Expand Up @@ -63,10 +53,3 @@ And then use it the same way on the page.
jm.shoot()
</script>
```

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.
25 changes: 4 additions & 21 deletions docs/zh/1.usage.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@
[目录](index.md)

* [基本用法 *](1.usage.md)
* [选项](2.options.md)
* [界面操控](3.operation.md)
* [实验性功能](experimental-features.md)
* [截图 (导出图片)](plugin-screenshot.md)
* [参与贡献](4.contribution.md)
* [贡献代码指南](5.development.md)

1.1. 基本框架
基本框架
===

首先,需要在页面上引用 jsmind.js 和 jsmind.css 两个文件,这里我们引用的是 CDN 上的资源,请注意使用最新的版本。
Expand Down Expand Up @@ -70,7 +60,7 @@
</script>
```

1.2. 数据格式
数据格式
===

jsMind 支持三种数据格式,分别是 `node_tree``node_array``freemind` 格式。jsMind 可以加载其中任一种格式,也能将数据导出为任一种格式。
Expand Down Expand Up @@ -184,7 +174,7 @@ var mind = {

```

1.3. 主题
主题
===

jsMind 默认提供了 15 种主题,你可以访问[功能示例](http://hizzgdev.github.io/jsmind/example/2_features.html)页面浏览这些主题。
Expand Down Expand Up @@ -217,7 +207,7 @@ jmnodes.theme-greensea jmexpander{} /* 展
jmnodes.theme-greensea jmexpander:hover{} /* 鼠标悬停展开/关闭节点的控制点样式 */
```

1.4. 样式
样式
===

除了上述主题外,你还可以为每一个节点设置单独的样式,目前 jsMind 支持以下自定义样式:
Expand Down Expand Up @@ -264,10 +254,3 @@ var mind = {
...
}
```
版权声明
===
禁止转载、禁止演绎。
jsMind 项目仍在不断升级变化,版本更新时会同时更新对应的文档。为避免给使用者带来困惑,在没有得到书面许可前,禁止转载本文档,同时禁止对本文档进行任何形式的更改。
Loading

0 comments on commit c681871

Please sign in to comment.