Commit 918fe8f3 authored by techird's avatar techird

add readme

parent d4801e20
# KityMinder-Core 更新日志
## v1.0.0
## v1.4.0
完成从[原仓库](https://github.com/fex-team/kityminder)的代码迁移
完成从[原仓库](https://github.com/fex-team/kityminder)的代码迁移。处于兼容性考虑,版本号直接从 1.4.0 开始。
Kity Minder
KityMinder Core
==========
## 简介
KityMinder 是百度 FEX 团队的 f-cube 小组(原 UEditor 小组)的又一力作。作为一款在线的脑图编辑工具,它有着不亚于 native 脑图工具的交互体验。同时,它充分发挥了 Web 云存储的优势,可以直接将编辑中的脑图同步到云端。此外,借由独创的 “云盘分享”功能,用户可以一键将当前编辑的脑图直接生成在线链接共享给其他用户,实现无缝沟通
KityMinder 是一款强大的脑图可视化/编辑工具,有百度 FEX 团队开发并维护
![KityMinder](snap.png "KityMinder 界面")
本仓库是 KityMinder 的核心实现部分:
KityMinder 基于 SVG 技术实现,支持绝大多数的主流浏览器,包括:
* 包括脑图数据的可视化展示(Json 格式)
* 包括简单的编辑功能(节点创建、编辑、删除)。更加强大编辑功能的 KityMinder 编辑器请移步 [kityminder-editor](https://github.com/fex-team/kityminder-editor)
* 不包含第三方格式(FreeMind、XMind、MindManager、纯文本、Markdown 等)的支持,可以加载 [kityminder-protocol](https://github.com/fex-team/kityminder-protocol) 来扩展第三方格式支持。
* 不包含文件存储的支持,需要自行实现存储。可参照[百度脑图](https://github.com/fex-team/naotu.baidu.com) 中的开源的 fio + 百度网盘方案进行实现。
## 使用
可以参考 [example.html](example.html) 进行使用,代码类似:
```js
<div id="minder-container"></div>
<script type="text/javascript" src="kityminder.all.min.js"></script>
<script type="text/javascript">
var minder = new kityminder.Minder({
renderTo: 'minder-container'
});
</script>
```
## 兼容性
KityMinder 基于 SVG 技术实现,支持绝大多数的 HTML5 浏览器,包括:
1. Chrome
2. Firefox
3. Safari
4. Internet Explorer 10 或以上
## 线上版本
## 依赖说明
产品地址:[http://naotu.baidu.com](http://naotu.baidu.com)
kityminder-core 依赖 Kity、库。需要二次开发 kityminder-core,需要初始化并更新子模块:
## 依赖说明
```bash
git submodule init
git submodule update
```
KityMinder 依赖 Kity、FIO、FUI 库。需要二次开发 KityMinder,需要先从 Github 上拉代码下来
kityminder-core 的 example 使用 seajs 进行包加载,seajs 可以使用 bower 获取
```bash
git clone https://github.com/fex-team/kityminder.git
bower install
```
紧接着,需要初始化并更新子模块
kityminder-core 使用 grunt 进行打包,安装 npm 组件后直接 grunt 即可打包
```bash
git submodule init
git submodule update
npm install
grunt
```
## 联系我们
问题和建议反馈:[Github Issues](https://github.com/fex-team/kityminder/issues/new)
问题和建议反馈:[Github Issues](https://github.com/fex-team/kityminder-core/issues)
邮件组: kity@baidu.com
QQ 讨论群: 374918234
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment