jsmind 0.7.4 → 0.7.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -12,12 +12,6 @@ jsMind is mind map library built by javascript, it base on html5 canvas and svg.
12
12
  - [jsMind on Github](https://github.com/hizzgdev/jsmind)
13
13
  - [国内镜像 - Gitee](https://gitee.com/hizzgdev/jsmind)
14
14
 
15
- ## !! BREAK CHANGE - Legacy Version is Deprecated !!
16
-
17
- ES6 版本现已发布,老版本已下线,详情请查阅 [es6/README.md](es6/README.md)
18
-
19
- The ES6 version of jsMind has been launched, and legacy version has been deprecated. see details from [es6/README-en.md](es6/README-en.md)
20
-
21
15
  ## Get Started
22
16
 
23
17
  ```html
@@ -26,16 +20,12 @@ The ES6 version of jsMind has been launched, and legacy version has been depreca
26
20
  <link
27
21
  type="text/css"
28
22
  rel="stylesheet"
29
- href="//cdn.jsdelivr.net/npm/jsmind@0.7.4/style/jsmind.css"
23
+ href="//cdn.jsdelivr.net/npm/jsmind@0.7.5/style/jsmind.css"
30
24
  />
31
25
  <script
32
26
  type="text/javascript"
33
- src="//cdn.jsdelivr.net/npm/jsmind@0.7.4/es6/jsmind.js"
27
+ src="//cdn.jsdelivr.net/npm/jsmind@0.7.5/es6/jsmind.js"
34
28
  ></script>
35
- <!--
36
- enable draggable node feature
37
- <script type="text/javascript" src="//cdn.jsdelivr.net/npm/jsmind@0.7.4/es6/jsmind.draggable-node.js"></script>
38
- -->
39
29
  </head>
40
30
  <body>
41
31
  <div id="jsmind_container"></div>
@@ -57,29 +47,28 @@ The ES6 version of jsMind has been launched, and legacy version has been depreca
57
47
  </html>
58
48
  ```
59
49
 
60
- > More samples : https://github.com/hizzgdev/jsmind-samples
61
-
62
- > 查阅[文档](docs/zh/1.usage.md)以获取更多关于 CDN 以及版本的知识。 Read the [doc](docs/en/1.usage.md) to learn more knowledge about CDN and version.
63
-
64
50
  ## Links
65
51
 
66
52
  - Resources:
67
- - [NPM - jsmind](https://www.npmjs.com/package/jsmind)
68
- - CDN - [UNPKG](https://unpkg.com/browse/jsmind/), [jsDelivr](https://www.jsdelivr.com/package/npm/jsmind/), [jsDelivr 的国内镜像](https://jsd.onmicrosoft.cn/npm/jsmind/)
69
53
  - [文档 - Documents](https://hizzgdev.github.io/jsmind/docs)
54
+ - [NPM - jsmind](https://www.npmjs.com/package/jsmind)
55
+ - CDN - [用法](docs/zh/1.usage.md) [Usage](docs/en/1.usage.md)
56
+ - [UNPKG](https://unpkg.com/browse/jsmind/)
57
+ - [jsDelivr](https://www.jsdelivr.com/package/npm/jsmind/)
58
+ - [jsDelivr 国内镜像](https://jsd.onmicrosoft.cn/npm/jsmind/)
70
59
  - Apps :
71
60
  - <https://jsmind.online>
72
61
  - <https://jsmind.sinaapp.com>
73
62
  - Demo :
74
63
  - [显示一个脑图 Render a mindmap](https://hizzgdev.github.io/jsmind/example/1_basic.html) [[国内版](https://hizzgdev.github.io/jsmind/example/1_basic_cn.html)]
75
- - [试用所有功能 Features simple](https://hizzgdev.github.io/jsmind/example/2_features.html) [[国内版](https://hizzgdev.github.io/jsmind/example/2_features_cn.html)]
64
+ - [试用所有功能 Try all features](https://hizzgdev.github.io/jsmind/example/2_features.html) [[国内版](https://hizzgdev.github.io/jsmind/example/2_features_cn.html)]
76
65
  - [requirejs + jsMind](https://hizzgdev.github.io/jsmind/example/3_requirejs.html)
66
+ - [更多示例 - More samples](https://github.com/hizzgdev/jsmind-samples)
77
67
 
78
- ## Donate
68
+ ## Funding
79
69
 
80
70
  - [致谢 - Acknowledgement](https://hizzgdev.github.io/acknowledgement.html)
81
- - [资助本项目](https://hizzgdev.github.io/sponsor.html)
82
- - [Become a sponsor](https://github.com/sponsors/hizzgdev)
71
+ - [资助 - Sponsor](https://hizzgdev.github.io/sponsor.html)
83
72
 
84
73
  ## Maintainer
85
74
 
@@ -1,9 +1,10 @@
1
1
  [Table of Contents](index.md)
2
2
 
3
- * [1. Usage *](1.usage.md)
4
- * [2. Options](2.options.md)
5
- * [3. Operation](3.operation.md)
3
+ * [Usage *](1.usage.md)
4
+ * [Options](2.options.md)
5
+ * [Operation](3.operation.md)
6
6
  * [Experimental Features](experimental-features.md)
7
+ * [Screenshot (Export as Image)](plugin-screenshot.md)
7
8
  * [Contribution](4.contribution.md)
8
9
  * [Development Guide](5.development.md)
9
10
 
@@ -13,22 +14,22 @@
13
14
  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.
14
15
 
15
16
  ```html
16
- <link type="text/css" rel="stylesheet" href="https://unpkg.com/jsmind@0.7.4/style/jsmind.css" />
17
+ <link type="text/css" rel="stylesheet" href="https://unpkg.com/jsmind@0.7.5/style/jsmind.css" />
17
18
 
18
- <script type="text/javascript" src="https://unpkg.com/jsmind@0.7.4/es6/jsmind.js"></script>
19
+ <script type="text/javascript" src="https://unpkg.com/jsmind@0.7.5/es6/jsmind.js"></script>
19
20
 
20
21
  ```
21
- > CDN: other available CDNs are [jsDelivr](https://www.jsdelivr.com/package/npm/jsmind/), and [the mirror of jsDelivr in China](https://jsd.onmicrosoft.cn/npm/jsmind/). the resource urls would look like:
22
- > - https://unpkg.com/jsmind@0.7.4/es6/jsmind.js
23
- > - https://cdn.jsdelivr.net/npm/jsmind@0.7.4/es6/jsmind.js
24
- > - https://jsd.onmicrosoft.cn/npm/jsmind@0.7.4/es6/jsmind.js
25
-
26
- > Version: the version number appear in the url of CDN. It's strongly recommended that you also specify the version number in your project to avoid the risks that caused by version upgrades. Access the [jsMind on NPS](https://www.npmjs.com/package/jsmind) to get the latest version number of jsMind.
22
+ > CDNs in common use: [UNPKG](https://unpkg.com/jsmind/), [jsDelivr](https://www.jsdelivr.com/package/npm/jsmind/), and [the mirror of jsDelivr in China](https://jsd.onmicrosoft.cn/npm/jsmind/). the resource urls would look like:
23
+ > - https://unpkg.com/jsmind@0.7.5/es6/jsmind.js
24
+ > - https://cdn.jsdelivr.net/npm/jsmind@0.7.5/es6/jsmind.js
25
+ > - https://jsd.onmicrosoft.cn/npm/jsmind@0.7.5/es6/jsmind.js
26
+ >
27
+ > The version number appear in the url of CDN. It's strongly recommended that you also specify the version number in your project to avoid the risks that caused by version upgrades. Access the [jsMind on NPM](https://www.npmjs.com/package/jsmind) to get the latest version number of jsMind.
27
28
 
28
29
  Add script jsmind.draggable-node.js for enabling draggable node feature.
29
30
 
30
31
  ```html
31
- <script type="text/javascript" src="https://unpkg.com/jsmind@0.7.4/es6/jsmind.draggable-node.js"></script>
32
+ <script type="text/javascript" src="https://unpkg.com/jsmind@0.7.5/es6/jsmind.draggable-node.js"></script>
32
33
  ```
33
34
 
34
35
  The second, a div element should be in your HTML as container
@@ -1,9 +1,10 @@
1
1
  [Table of Contents](index.md)
2
2
 
3
- * [1. Usage](1.usage.md)
4
- * [2. Options *](2.options.md)
5
- * [3. Operation](3.operation.md)
3
+ * [Usage](1.usage.md)
4
+ * [Options *](2.options.md)
5
+ * [Operation](3.operation.md)
6
6
  * [Experimental Features](experimental-features.md)
7
+ * [Screenshot (Export as Image)](plugin-screenshot.md)
7
8
  * [Contribution](4.contribution.md)
8
9
  * [Development Guide](5.development.md)
9
10
 
@@ -1,9 +1,10 @@
1
1
  [Table of Contents](index.md)
2
2
 
3
- * [1. Usage](1.usage.md)
4
- * [2. Options](2.options.md)
5
- * [3. Operation *](3.operation.md)
3
+ * [Usage](1.usage.md)
4
+ * [Options](2.options.md)
5
+ * [Operation *](3.operation.md)
6
6
  * [Experimental Features](experimental-features.md)
7
+ * [Screenshot (Export as Image)](plugin-screenshot.md)
7
8
  * [Contribution](4.contribution.md)
8
9
  * [Development Guide](5.development.md)
9
10
 
@@ -1,9 +1,10 @@
1
1
  [Table of Contents](index.md)
2
2
 
3
- * [1. Usage](1.usage.md)
4
- * [2. Options](2.options.md)
5
- * [3. Operation](3.operation.md)
3
+ * [Usage](1.usage.md)
4
+ * [Options](2.options.md)
5
+ * [Operation](3.operation.md)
6
6
  * [Experimental Features](experimental-features.md)
7
+ * [Screenshot (Export as Image)](plugin-screenshot.md)
7
8
  * [Contribution *](4.contribution.md)
8
9
  * [Development Guide](5.development.md)
9
10
 
@@ -1,9 +1,10 @@
1
1
  [Table of Contents](index.md)
2
2
 
3
- * [1. Usage](1.usage.md)
4
- * [2. Options](2.options.md)
5
- * [3. Operation](3.operation.md)
3
+ * [Usage](1.usage.md)
4
+ * [Options](2.options.md)
5
+ * [Operation](3.operation.md)
6
6
  * [Experimental Features](experimental-features.md)
7
+ * [Screenshot (Export as Image)](plugin-screenshot.md)
7
8
  * [Contribution](4.contribution.md)
8
9
  * [Development Guide *](5.development.md)
9
10
 
@@ -79,7 +80,7 @@ it is strongly recommended to test all the use cases on the page, no matter you
79
80
  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.
80
81
 
81
82
 
82
- copyright notice
83
+ copyright
83
84
  ===
84
85
 
85
86
  Reproduction and deduction are prohibited.
@@ -1,63 +1,27 @@
1
1
  [Table of Contents](index.md)
2
2
 
3
- * [1. Usage](1.usage.md)
4
- * [2. Options](2.options.md)
5
- * [3. Operation](3.operation.md)
3
+ * [Usage](1.usage.md)
4
+ * [Options](2.options.md)
5
+ * [Operation](3.operation.md)
6
6
  * [Experimental Features *](experimental-features.md)
7
+ * [Screenshot (Export as Image)](plugin-screenshot.md)
7
8
  * [Contribution](4.contribution.md)
8
9
  * [Development Guide](5.development.md)
9
10
 
10
- > Special note: These experimental features are not guaranteed to continue to exist in subsequent versions, nor are their API compatibility guaranteed. If experimental features are used in your project, please upgrade jsmind with caution in the future.
11
-
12
- Export Image/Screenshot
11
+ Experimental Features
13
12
  ===
14
- This feature can support to export mind maps as png images.
15
-
16
- ```html
17
-
18
- <!-- style -->
19
- <link type="text/css" rel="stylesheet" href="https://unpkg.com/jsmind@0.7.4/style/jsmind.css" />
20
-
21
- <!-- jsMind -->
22
- <script type="text/javascript" src="https://unpkg.com/jsmind@0.7.4/es6/jsmind.js"></script>
23
13
 
24
- <!-- dependency of screenshot -->
25
- <script type="text/javascript" src="https://unpkg.com/dom-to-image@2.6.0/dist/dom-to-image.min.js" ></script>
14
+ Some contents in the documents are annotated with `experimental`, indicating that those features are currently in experimental stage, which means those features may be changed in the future. The experimental features are neither guaranteed to continue to exist in subsequent versions, nor guaranteed their backward compatibility. If any experimental feature is used in your project, you'd better test them carefully when you upgrade jsmind in the future.
26
15
 
27
- <!-- screenshot plugin -->
28
- <script type="text/javascript" src="https://unpkg.com/jsmind@0.7.4/es6/jsmind.screenshot.js"></script>
29
16
 
17
+ List of Experimental Features:
30
18
 
31
- <script>
32
- var jm = new jsMind(options);
33
- jm.show(mind_data);
34
- // export current mindmap to an image
35
- jm.shoot()
36
- </script>
19
+ - [Screenshot (Export as Image)](plugin-screenshot.md)
37
20
 
38
- ```
39
21
 
40
- If you use npm, please install `jsmind` and `dom-to-image`
41
-
42
- ```bash
43
- npm install jsmind
44
- npm install dom-to-image
45
- ```
46
-
47
- And then use it the same way on the page.
48
-
49
- ```html
50
- <script>
51
- import domtoimage from 'dom-to-image';
52
- import jsMind from 'jsmind'
53
- import 'jsmind/screenshot'
54
- import 'jsmind/style/jsmind.css'
22
+ copyright notice
23
+ ===
55
24
 
56
- // ...
25
+ Reproduction and deduction are prohibited.
57
26
 
58
- var jm = new jsMind(options);
59
- jm.show(mind_data);
60
- // export current mindmap to an image
61
- jm.shoot()
62
- </script>
63
- ```
27
+ 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.
package/docs/en/index.md CHANGED
@@ -1,25 +1,26 @@
1
1
  Table of Contents
2
2
  ======
3
3
 
4
- * [1. Usage](1.usage.md)
5
- * 1.1 Basic Framework
6
- * 1.2 Data Format
7
- * 1.3 Themes
8
- * 1.4 Styles
9
- * [2. Options](2.options.md)
10
- * 2.1 Introduction
11
- * 2.2 Conventional Options
12
- * 2.3 Layout Options
13
- * 2.4 Shortcuts
14
- * [3. API / Operation](3.operation.md)
15
- * 3.1 Displaying a Mindmap
16
- * 3.2 Finding Nodes
17
- * 3.3 Operation on Nodes
18
- * 3.4 Editing Nodes
19
- * 3.5 Setting Style
20
- * 3.6 Access to Data
21
- * 3.7 Other Operations
4
+ * [Usage](1.usage.md)
5
+ * Basic Framework
6
+ * Data Format
7
+ * Themes
8
+ * Styles
9
+ * [Options](2.options.md)
10
+ * Introduction
11
+ * Conventional Options
12
+ * Layout Options
13
+ * Shortcuts
14
+ * [API / Operation](3.operation.md)
15
+ * Rendering a Mindmap
16
+ * Finding Nodes
17
+ * Operation on Nodes
18
+ * Editing Nodes
19
+ * Setting Style
20
+ * Access to Data
21
+ * Other Operations
22
22
  * [Experimental Features](experimental-features.md)
23
+ * [Screenshot (Export as Image)](plugin-screenshot.md)
23
24
  * [Contribution](4.contribution.md)
24
25
  * [Development Guide](5.development.md)
25
26
 
@@ -0,0 +1,72 @@
1
+ [Table of Contents](index.md)
2
+
3
+ * [Usage](1.usage.md)
4
+ * [Options](2.options.md)
5
+ * [Operation](3.operation.md)
6
+ * [Experimental Features](experimental-features.md)
7
+ * [Screenshot (Export as Image) *](plugin-screenshot.md)
8
+ * [Contribution](4.contribution.md)
9
+ * [Development Guide](5.development.md)
10
+
11
+ Screenshot (Export as Image) <sup>[experimental](experimental-features.md)</sup>
12
+ ===
13
+
14
+ > It's strongly recommended that you read [Experimental Features](experimental-features.md) to fully understand the risks before using this feature.
15
+
16
+ This feature can support to export mind maps as png images.
17
+
18
+ ```html
19
+
20
+ <!-- style -->
21
+ <link type="text/css" rel="stylesheet" href="https://unpkg.com/jsmind@0.7.5/style/jsmind.css" />
22
+
23
+ <!-- jsMind -->
24
+ <script type="text/javascript" src="https://unpkg.com/jsmind@0.7.5/es6/jsmind.js"></script>
25
+
26
+ <!-- dependency of screenshot -->
27
+ <script type="text/javascript" src="https://unpkg.com/dom-to-image@2.6.0/dist/dom-to-image.min.js" ></script>
28
+
29
+ <!-- screenshot plugin -->
30
+ <script type="text/javascript" src="https://unpkg.com/jsmind@0.7.5/es6/jsmind.screenshot.js"></script>
31
+
32
+
33
+ <script>
34
+ var jm = new jsMind(options);
35
+ jm.show(mind_data);
36
+ // export current mindmap to an image
37
+ jm.shoot()
38
+ </script>
39
+
40
+ ```
41
+
42
+ If you use npm, please install `jsmind` and `dom-to-image`
43
+
44
+ ```bash
45
+ npm install jsmind
46
+ npm install dom-to-image
47
+ ```
48
+
49
+ And then use it the same way on the page.
50
+
51
+ ```html
52
+ <script>
53
+ import domtoimage from 'dom-to-image';
54
+ import jsMind from 'jsmind'
55
+ import 'jsmind/screenshot'
56
+ import 'jsmind/style/jsmind.css'
57
+
58
+ // ...
59
+
60
+ var jm = new jsMind(options);
61
+ jm.show(mind_data);
62
+ // export current mindmap to an image
63
+ jm.shoot()
64
+ </script>
65
+ ```
66
+
67
+ copyright notice
68
+ ===
69
+
70
+ Reproduction and deduction are prohibited.
71
+
72
+ 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.
package/docs/index.md CHANGED
@@ -1,9 +1,9 @@
1
1
  ## 中文
2
2
 
3
3
  * [目录](zh/index.md)
4
- * [1. 基本用法](zh/1.usage.md)
5
- * [2. 选项](zh/2.options.md)
6
- * [3. 界面操控](zh/3.operation.md)
4
+ * [基本用法](zh/1.usage.md)
5
+ * [选项](zh/2.options.md)
6
+ * [界面操控](zh/3.operation.md)
7
7
  * [实验性功能](zh/experimental-features.md)
8
8
  * [参与贡献](zh/4.contribution.md)
9
9
  * [贡献代码指南](zh/5.development.md)
@@ -11,9 +11,9 @@
11
11
  ## English
12
12
 
13
13
  * [Table of Contents](en/index.md)
14
- * [1. Usage](en/1.usage.md)
15
- * [2. Options](en/2.options.md)
16
- * [3. API / Operation](en/3.operation.md)
14
+ * [Usage](en/1.usage.md)
15
+ * [Options](en/2.options.md)
16
+ * [API / Operation](en/3.operation.md)
17
17
  * [Experimental Features](en/experimental-features.md)
18
18
  * [Contribution](en/4.contribution.md)
19
19
  * [Development Guide](en/5.development.md)
@@ -1,9 +1,10 @@
1
1
  [目录](index.md)
2
2
 
3
- * [1. 基本用法 *](1.usage.md)
4
- * [2. 选项](2.options.md)
5
- * [3. 界面操控](3.operation.md)
3
+ * [基本用法 *](1.usage.md)
4
+ * [选项](2.options.md)
5
+ * [界面操控](3.operation.md)
6
6
  * [实验性功能](experimental-features.md)
7
+ * [截图 (导出图片)](plugin-screenshot.md)
7
8
  * [参与贡献](4.contribution.md)
8
9
  * [贡献代码指南](5.development.md)
9
10
 
@@ -14,22 +15,22 @@
14
15
 
15
16
 
16
17
  ```html
17
- <link type="text/css" rel="stylesheet" href="https://unpkg.com/jsmind@0.7.4/style/jsmind.css" />
18
+ <link type="text/css" rel="stylesheet" href="https://unpkg.com/jsmind@0.7.5/style/jsmind.css" />
18
19
 
19
- <script type="text/javascript" src="https://unpkg.com/jsmind@0.7.4/es6/jsmind.js"></script>
20
+ <script type="text/javascript" src="https://unpkg.com/jsmind@0.7.5/es6/jsmind.js"></script>
20
21
  ```
21
22
 
22
- > CDN:其它可用的 CDN 还有 [jsDelivr](https://www.jsdelivr.com/package/npm/jsmind/),以及 jsDelivr 的[国内镜像](https://jsd.onmicrosoft.cn/npm/jsmind/)。文件路径大概像这样:
23
- > - https://unpkg.com/jsmind@0.7.4/es6/jsmind.js
24
- > - https://cdn.jsdelivr.net/npm/jsmind@0.7.4/es6/jsmind.js
25
- > - https://jsd.onmicrosoft.cn/npm/jsmind@0.7.4/es6/jsmind.js
26
-
27
- > 版本:上面的示例url中都有版本号,强烈建议你在项目里也指明版本号,以避免版本升级给你的项目带来风险。访问 [NPS 上的 jsMind](https://www.npmjs.com/package/jsmind) 可以获取 jsmind 的最新版本号。
23
+ > 常用的 CDN 有 [UNPKG](https://unpkg.com/jsmind/),[jsDelivr](https://www.jsdelivr.com/package/npm/jsmind/),以及 jsDelivr 的[国内镜像](https://jsd.onmicrosoft.cn/npm/jsmind/)。文件路径大概像这样:
24
+ > - https://unpkg.com/jsmind@0.7.5/es6/jsmind.js
25
+ > - https://cdn.jsdelivr.net/npm/jsmind@0.7.5/es6/jsmind.js
26
+ > - https://jsd.onmicrosoft.cn/npm/jsmind@0.7.5/es6/jsmind.js
27
+ >
28
+ > 示例中url中都有版本号,强烈建议你在项目里也指明版本号,以避免版本升级给你的项目带来风险。访问 [NPM 上的 jsMind](https://www.npmjs.com/package/jsmind) 可以获取 jsmind 的最新版本号。
28
29
 
29
30
  如果希望能够通过鼠标拖拽的方式移动节点,需要额外引用 jsmind.draggable-node.js 文件
30
31
 
31
32
  ```html
32
- <script type="text/javascript" src="https://unpkg.com/jsmind@0.7.4/es6/jsmind.draggable-node.js"></script>
33
+ <script type="text/javascript" src="https://unpkg.com/jsmind@0.7.5/es6/jsmind.draggable-node.js"></script>
33
34
  ```
34
35
 
35
36
  其次,要为 jsMind 准备一个容器,jsMind 将在这个容器里显示思维导图。可自行定义容器的id、大小及样式。
@@ -1,9 +1,10 @@
1
1
  [目录](index.md)
2
2
 
3
- * [1. 基本用法](1.usage.md)
4
- * [2. 选项 *](2.options.md)
5
- * [3. 界面操控](3.operation.md)
3
+ * [基本用法](1.usage.md)
4
+ * [选项 *](2.options.md)
5
+ * [界面操控](3.operation.md)
6
6
  * [实验性功能](experimental-features.md)
7
+ * [截图 (导出图片)](plugin-screenshot.md)
7
8
  * [参与贡献](4.contribution.md)
8
9
  * [贡献代码指南](5.development.md)
9
10
 
@@ -1,9 +1,10 @@
1
1
  [目录](index.md)
2
2
 
3
- * [1. 基本用法](1.usage.md)
4
- * [2. 选项](2.options.md)
5
- * [3. 界面操控 *](3.operation.md)
3
+ * [基本用法](1.usage.md)
4
+ * [选项](2.options.md)
5
+ * [界面操控 *](3.operation.md)
6
6
  * [实验性功能](experimental-features.md)
7
+ * [截图 (导出图片)](plugin-screenshot.md)
7
8
  * [参与贡献](4.contribution.md)
8
9
  * [贡献代码指南](5.development.md)
9
10
 
@@ -1,9 +1,10 @@
1
1
  [目录](index.md)
2
2
 
3
- * [1. 基本用法](1.usage.md)
4
- * [2. 选项](2.options.md)
5
- * [3. 界面操控](3.operation.md)
3
+ * [基本用法](1.usage.md)
4
+ * [选项](2.options.md)
5
+ * [界面操控](3.operation.md)
6
6
  * [实验性功能](experimental-features.md)
7
+ * [截图 (导出图片)](plugin-screenshot.md)
7
8
  * [参与贡献 *](4.contribution.md)
8
9
  * [贡献代码指南](5.development.md)
9
10
 
@@ -1,9 +1,10 @@
1
1
  [目录](index.md)
2
2
 
3
- * [1. 基本用法](1.usage.md)
4
- * [2. 选项](2.options.md)
5
- * [3. 界面操控](3.operation.md)
3
+ * [基本用法](1.usage.md)
4
+ * [选项](2.options.md)
5
+ * [界面操控](3.operation.md)
6
6
  * [实验性功能](experimental-features.md)
7
+ * [截图 (导出图片)](plugin-screenshot.md)
7
8
  * [参与贡献](4.contribution.md)
8
9
  * [贡献代码指南 *](5.development.md)
9
10
 
@@ -1,64 +1,27 @@
1
1
 
2
2
  [目录](index.md)
3
3
 
4
- * [1. 基本用法](1.usage.md)
5
- * [2. 选项](2.options.md)
6
- * [3. 界面操控](3.operation.md)
4
+ * [基本用法](1.usage.md)
5
+ * [选项](2.options.md)
6
+ * [界面操控](3.operation.md)
7
7
  * [实验性功能 *](experimental-features.md)
8
+ * [截图 (导出图片)](plugin-screenshot.md)
8
9
  * [参与贡献](4.contribution.md)
9
10
  * [贡献代码指南](5.development.md)
10
11
 
11
- > 特别注意:这些实验性功能并不保证在后续的版本中会一直存在,也不保证其 API 的兼容性,若在项目中使用了实验性功能,后续请谨慎升级。
12
-
13
- 导出图片/截图
12
+ 实验性功能
14
13
  ===
15
- 此功能可将思维导图导出为 png 格式的图片。
16
-
17
- ```html
18
-
19
- <!-- style -->
20
- <link type="text/css" rel="stylesheet" href="https://unpkg.com/jsmind@0.7.4/style/jsmind.css" />
21
-
22
- <!-- jsMind -->
23
- <script type="text/javascript" src="https://unpkg.com/jsmind@0.7.4/es6/jsmind.js"></script>
24
-
25
- <!-- dependency of screenshot -->
26
- <script type="text/javascript" src="https://unpkg.com/dom-to-image@2.6.0/dist/dom-to-image.min.js" ></script>
27
14
 
28
- <!-- screenshot plugin -->
29
- <script type="text/javascript" src="https://unpkg.com/jsmind@0.7.4/es6/jsmind.screenshot.js"></script>
15
+ 文档中有些内容标记了`[实验性]`注解,表明那些功能(特性)目前还处于实验阶段,这意味着这些功能在未来可能会发生变化。我们并不保证这些实验性功能在后续的版本中会一直存在,也不保证其的兼容性。如果你在项目中使用到了这些实验性功能,在后续对 jsMind 升级时,最好仔细测试它们。
30
16
 
17
+ 目前提供的实验性功能有:
18
+ - [截图 (导出图片)](plugin-screenshot.md) : 可将显示的思维导图导出为一张图片。
31
19
 
32
- <script>
33
- var jm = new jsMind(options);
34
- jm.show(mind_data);
35
- // export current mindmap to an image
36
- jm.shoot()
37
- </script>
38
20
 
39
- ```
40
21
 
41
- 如果使用 npm,则需要安装 jsmind 和 dom-to-image
42
-
43
- ```bash
44
- npm install jsmind
45
- npm install dom-to-image
46
- ```
47
-
48
- 然后在页面里一样的使用
49
-
50
- ```html
51
- <script>
52
- import domtoimage from 'dom-to-image';
53
- import jsMind from 'jsmind'
54
- import 'jsmind/screenshot'
55
- import 'jsmind/style/jsmind.css'
22
+ 版权声明
23
+ ===
56
24
 
57
- // ...
25
+ 禁止转载、禁止演绎。
58
26
 
59
- var jm = new jsMind(options);
60
- jm.show(mind_data);
61
- // export current mindmap to an image
62
- jm.shoot()
63
- </script>
64
- ```
27
+ jsMind 项目仍在不断升级变化,版本更新时会同时更新对应的文档。为避免给使用者带来困惑,在没有得到书面许可前,禁止转载本文档,同时禁止对本文档进行任何形式的更改。
package/docs/zh/index.md CHANGED
@@ -1,25 +1,26 @@
1
1
  目录
2
2
  ======
3
3
 
4
- * [1. 基本用法](1.usage.md)
5
- * 1.1. 基本框架
6
- * 1.2. 数据格式
7
- * 1.3. 主题
8
- * 1.4. 样式
9
- * [2. 选项](2.options.md)
10
- * 2.1. 综述
11
- * 2.2. 常规选项
12
- * 2.3. 布局选项
13
- * 2.4. 快捷键
14
- * [3. 界面操控](3.operation.md)
15
- * 3.1. 显示思维导图
16
- * 3.2. 查找节点
17
- * 3.3. 操作节点
18
- * 3.4. 编辑节点
19
- * 3.5. 设置样式
20
- * 3.6. 获取数据
21
- * 3.7. 其它操作
4
+ * [基本用法](1.usage.md)
5
+ * 基本框架
6
+ * 数据格式
7
+ * 主题
8
+ * 样式
9
+ * [选项](2.options.md)
10
+ * 综述
11
+ * 常规选项
12
+ * 布局选项
13
+ * 快捷键
14
+ * [界面操控](3.operation.md)
15
+ * 显示思维导图
16
+ * 查找节点
17
+ * 操作节点
18
+ * 编辑节点
19
+ * 设置样式
20
+ * 获取数据
21
+ * 其它操作
22
22
  * [实验性功能](experimental-features.md)
23
+ * [截图 (导出图片)](plugin-screenshot.md)
23
24
  * [参与贡献](4.contribution.md)
24
25
  * [贡献代码指南](5.development.md)
25
26