Doc:更新文档

This commit is contained in:
wanglin2 2023-03-24 10:31:21 +08:00
parent cda1da5fd0
commit c18c037642
14 changed files with 170 additions and 11 deletions

View File

@ -28,6 +28,7 @@ let APIList = [
'watermark',
'associativeLine',
'xmind',
'markdown',
'utils'
]

View File

@ -4,6 +4,8 @@
optimization: 1.During rich text editing, when initially focusing, all are no longer selected by default; 2.When editing rich text, use the node fill color as the background color to avoid being invisible when the node color is white.
New: 1.Support for importing and exporting Markdown format files.
## 0.4.6
New: 1.Associated lines support adjusting control points.

View File

@ -3,6 +3,7 @@
<h1>Changelog</h1>
<h2>0.4.7</h2>
<p>optimization: 1.During rich text editing, when initially focusing, all are no longer selected by default; 2.When editing rich text, use the node fill color as the background color to avoid being invisible when the node color is white.</p>
<p>New: 1.Support for importing and exporting Markdown format files.</p>
<h2>0.4.6</h2>
<p>New: 1.Associated lines support adjusting control points.</p>
<p>optimization: 1.When adding historical data, filter data that has not changed compared to the previous time.</p>

View File

@ -0,0 +1,35 @@
# Markdown parse
> v0.4.7+
Provides methods for importing and exporting `Markdown` files.
## Import
```js
import markdown from 'simple-mind-map/src/parse/markdown.js'
```
If you are using the file in the format of `umd`, you can obtain it in the following way:
```html
<script src="simple-mind-map/dist/simpleMindMap.umd.min.js"></script>
```
```js
MindMap.markdown
```
## Methods
### transformToMarkdown(data)
- `data`: Mind map data can be obtained using the `mindMap.getData()` method.
Convert mind map data into `Markdown` format data, and the returned data is a string.
### transformMarkdownTo(mdContent)
- `mdContent`: The `Markdown` data to convert, string type.
Convert the `Markdown` string into node tree data and return a `Promise` instance. You can use the `mindMap.setData()` method to render the converted data onto the canvas.

View File

@ -0,0 +1,39 @@
<template>
<div>
<h1>Markdown parse</h1>
<blockquote>
<p>v0.4.7+</p>
</blockquote>
<p>Provides methods for importing and exporting <code>Markdown</code> files.</p>
<h2>Import</h2>
<pre class="hljs"><code><span class="hljs-keyword">import</span> markdown <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;simple-mind-map/src/parse/markdown.js&#x27;</span>
</code></pre>
<p>If you are using the file in the format of <code>umd</code>, you can obtain it in the following way:</p>
<pre class="hljs"><code><span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">&quot;simple-mind-map/dist/simpleMindMap.umd.min.js&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
</code></pre>
<pre class="hljs"><code>MindMap.markdown
</code></pre>
<h2>Methods</h2>
<h3>transformToMarkdown(data)</h3>
<ul>
<li><code>data</code>: Mind map data can be obtained using the <code>mindMap.getData()</code> method.</li>
</ul>
<p>Convert mind map data into <code>Markdown</code> format data, and the returned data is a string.</p>
<h3>transformMarkdownTo(mdContent)</h3>
<ul>
<li><code>mdContent</code>: The <code>Markdown</code> data to convert, string type.</li>
</ul>
<p>Convert the <code>Markdown</code> string into node tree data and return a <code>Promise</code> instance. You can use the <code>mindMap.setData()</code> method to render the converted data onto the canvas.</p>
</div>
</template>
<script>
export default {
}
</script>
<style>
</style>

View File

@ -12,9 +12,11 @@ import xmind from 'simple-mind-map/src/parse/xmind.js'
If you are using the file in the format of `umd`, you can obtain it in the following way:
```js
import MindMap from "simple-mind-map/dist/simpleMindMap.umd.min"
```html
<script src="simple-mind-map/dist/simpleMindMap.umd.min.js"></script>
```
```js
MindMap.xmind
```

View File

@ -9,9 +9,9 @@
<pre class="hljs"><code><span class="hljs-keyword">import</span> xmind <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;simple-mind-map/src/parse/xmind.js&#x27;</span>
</code></pre>
<p>If you are using the file in the format of <code>umd</code>, you can obtain it in the following way:</p>
<pre class="hljs"><code><span class="hljs-keyword">import</span> MindMap <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;simple-mind-map/dist/simpleMindMap.umd.min&quot;</span>
MindMap.xmind
<pre class="hljs"><code><span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">&quot;simple-mind-map/dist/simpleMindMap.umd.min.js&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
</code></pre>
<pre class="hljs"><code>MindMap.xmind
</code></pre>
<h2>Methods</h2>
<h3>xmind.parseXmindFile(file)</h3>

View File

@ -1,3 +1,3 @@
export default [{"lang":"zh","children":[{"path":"associativeLine","title":"AssociativeLine 插件"},{"path":"batchExecution","title":"BatchExecution实例"},{"path":"changelog","title":"Changelog"},{"path":"command","title":"Command实例"},{"path":"constructor","title":"构造函数"},{"path":"doExport","title":"Export 插件"},{"path":"drag","title":"Drag插件"},{"path":"introduction","title":"简介"},{"path":"keyboardNavigation","title":"KeyboardNavigation插件"},{"path":"keyCommand","title":"KeyCommand实例"},{"path":"miniMap","title":"MiniMap插件"},{"path":"node","title":"Node实例"},{"path":"render","title":"Render实例"},{"path":"richText","title":"RichText插件"},{"path":"select","title":"Select 插件 "},{"path":"start","title":"开始"},{"path":"translate","title":"参与翻译"},{"path":"utils","title":"内置工具方法"},{"path":"view","title":"View实例"},{"path":"watermark","title":"Watermark插件"},{"path":"xmind","title":"XMind解析"}]},{"lang":"en","children":[{"path":"associativeLine","title":"AssociativeLine plugin"},{"path":"batchExecution","title":"batchExecution instance"},{"path":"changelog","title":"Changelog"},{"path":"command","title":"command instance"},{"path":"constructor","title":"Constructor"},{"path":"doExport","title":"Export plugin"},{"path":"drag","title":"Drag plugin"},{"path":"introduction","title":"Introduction"},{"path":"keyboardNavigation","title":"KeyboardNavigation plugin"},{"path":"keyCommand","title":"KeyCommand instance"},{"path":"miniMap","title":"MiniMap plugin"},{"path":"node","title":"Node instance"},{"path":"render","title":"Render instance"},{"path":"richText","title":"RichText plugin"},{"path":"select","title":"Select plugin"},{"path":"start","title":"Start"},{"path":"translate","title":"Participate in translation"},{"path":"utils","title":"Utility Methods"},{"path":"view","title":"View instance"},{"path":"watermark","title":"Watermark plugin"},{"path":"xmind","title":"XMind parse"}]}]
export default [{"lang":"zh","children":[{"path":"associativeLine","title":"AssociativeLine 插件"},{"path":"batchExecution","title":"BatchExecution实例"},{"path":"changelog","title":"Changelog"},{"path":"command","title":"Command实例"},{"path":"constructor","title":"构造函数"},{"path":"doExport","title":"Export 插件"},{"path":"drag","title":"Drag插件"},{"path":"introduction","title":"简介"},{"path":"keyboardNavigation","title":"KeyboardNavigation插件"},{"path":"keyCommand","title":"KeyCommand实例"},{"path":"miniMap","title":"MiniMap插件"},{"path":"node","title":"Node实例"},{"path":"render","title":"Render实例"},{"path":"richText","title":"RichText插件"},{"path":"select","title":"Select 插件 "},{"path":"start","title":"开始"},{"path":"translate","title":"参与翻译"},{"path":"utils","title":"内置工具方法"},{"path":"view","title":"View实例"},{"path":"watermark","title":"Watermark插件"},{"path":"xmind","title":"XMind解析"},{"path":"markdown","title":"Markdown解析"}]},{"lang":"en","children":[{"path":"associativeLine","title":"AssociativeLine plugin"},{"path":"batchExecution","title":"batchExecution instance"},{"path":"changelog","title":"Changelog"},{"path":"command","title":"command instance"},{"path":"constructor","title":"Constructor"},{"path":"doExport","title":"Export plugin"},{"path":"drag","title":"Drag plugin"},{"path":"introduction","title":"Introduction"},{"path":"keyboardNavigation","title":"KeyboardNavigation plugin"},{"path":"keyCommand","title":"KeyCommand instance"},{"path":"miniMap","title":"MiniMap plugin"},{"path":"node","title":"Node instance"},{"path":"render","title":"Render instance"},{"path":"richText","title":"RichText plugin"},{"path":"select","title":"Select plugin"},{"path":"start","title":"Start"},{"path":"translate","title":"Participate in translation"},{"path":"utils","title":"Utility Methods"},{"path":"view","title":"View instance"},{"path":"watermark","title":"Watermark plugin"},{"path":"xmind","title":"XMind parse"},{"path":"markdown","title":"Markdown parse"}]}]

View File

@ -4,6 +4,8 @@
优化1.富文本编辑时初始聚焦时不再默认全选2.富文本编辑时使用节点填充色作为背景色,避免节点颜色为白色时看不见。
新增1.支持导入和导出Markdown格式文件。
## 0.4.6
新增1.关联线支持调整控制点。

View File

@ -3,6 +3,7 @@
<h1>Changelog</h1>
<h2>0.4.7</h2>
<p>优化1.富文本编辑时初始聚焦时不再默认全选2.富文本编辑时使用节点填充色作为背景色避免节点颜色为白色时看不见</p>
<p>新增1.支持导入和导出Markdown格式文件</p>
<h2>0.4.6</h2>
<p>新增1.关联线支持调整控制点</p>
<p>优化1.添加历史数据时过滤和上一次相比没有改变的数据</p>

View File

@ -0,0 +1,35 @@
# Markdown解析
> v0.4.7+
提供导入和导出`Markdown`文件的方法。
## 引入
```js
import markdown from 'simple-mind-map/src/parse/markdown.js'
```
如果使用的是`umd`格式的文件,那么可以通过如下方式获取:
```html
<script src="simple-mind-map/dist/simpleMindMap.umd.min.js"></script>
```
```js
MindMap.markdown
```
## 方法
### transformToMarkdown(data)
- `data`:思维导图数据,可以通过`mindMap.getData()`方法获取。
将思维导图数据转换成`Markdown`格式数据,返回的是字符串。
### transformMarkdownTo(mdContent)
- `mdContent`:要转换的`Markdown`数据,字符串类型。
`Markdown`字符串转换成节点树数据,返回一个`Promise`实例。可以使用`mindMap.setData()`方法将转换后的数据渲染到画布上。

View File

@ -0,0 +1,39 @@
<template>
<div>
<h1>Markdown解析</h1>
<blockquote>
<p>v0.4.7+</p>
</blockquote>
<p>提供导入和导出<code>Markdown</code>文件的方法</p>
<h2>引入</h2>
<pre class="hljs"><code><span class="hljs-keyword">import</span> markdown <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;simple-mind-map/src/parse/markdown.js&#x27;</span>
</code></pre>
<p>如果使用的是<code>umd</code>格式的文件那么可以通过如下方式获取</p>
<pre class="hljs"><code><span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">&quot;simple-mind-map/dist/simpleMindMap.umd.min.js&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
</code></pre>
<pre class="hljs"><code>MindMap.markdown
</code></pre>
<h2>方法</h2>
<h3>transformToMarkdown(data)</h3>
<ul>
<li><code>data</code>思维导图数据可以通过<code>mindMap.getData()</code>方法获取</li>
</ul>
<p>将思维导图数据转换成<code>Markdown</code>格式数据返回的是字符串</p>
<h3>transformMarkdownTo(mdContent)</h3>
<ul>
<li><code>mdContent</code>要转换的<code>Markdown</code>数据字符串类型</li>
</ul>
<p><code>Markdown</code>字符串转换成节点树数据返回一个<code>Promise</code>实例可以使用<code>mindMap.setData()</code>方法将转换后的数据渲染到画布上</p>
</div>
</template>
<script>
export default {
}
</script>
<style>
</style>

View File

@ -12,9 +12,11 @@ import xmind from 'simple-mind-map/src/parse/xmind.js'
如果使用的是`umd`格式的文件,那么可以通过如下方式获取:
```js
import MindMap from "simple-mind-map/dist/simpleMindMap.umd.min"
```html
<script src="simple-mind-map/dist/simpleMindMap.umd.min.js"></script>
```
```js
MindMap.xmind
```

View File

@ -9,9 +9,9 @@
<pre class="hljs"><code><span class="hljs-keyword">import</span> xmind <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;simple-mind-map/src/parse/xmind.js&#x27;</span>
</code></pre>
<p>如果使用的是<code>umd</code>格式的文件那么可以通过如下方式获取</p>
<pre class="hljs"><code><span class="hljs-keyword">import</span> MindMap <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;simple-mind-map/dist/simpleMindMap.umd.min&quot;</span>
MindMap.xmind
<pre class="hljs"><code><span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">&quot;simple-mind-map/dist/simpleMindMap.umd.min.js&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
</code></pre>
<pre class="hljs"><code>MindMap.xmind
</code></pre>
<h2>方法</h2>
<h3>xmind.parseXmindFile(file)</h3>