diff --git a/README.md b/README.md index e96d4bb9..70b6cc55 100644 --- a/README.md +++ b/README.md @@ -20,25 +20,25 @@ ## 目录介绍 -1.simple-mind-map +1.`simple-mind-map` 思维导图工具库。 -2.web +2.`web` -使用`simple-mind-map`工具库,基于vue2.x、ElementUI搭建的在线思维导图。 +使用`simple-mind-map`工具库,基于`vue2.x`、`ElementUI`搭建的在线思维导图。 -3.dist +3.`dist` 打包后的资源文件夹。 -4.docs +4.`docs` 文档等。 ## 开发 -本地开发 +### 本地开发 ```bash git clone https://github.com/wanglin2/mind-map.git @@ -52,7 +52,27 @@ npm link simple-mind-map npm run serve ``` -打包 +### 打包库 + +自`0.2.0`版本开始增加了对核心库`simple-mind-map`的打包,复用了示例项目`web`的打包工具。 + +```bash +cd web +npm run buildLibrary +``` + +`simple-mind-map`库的`package.json`文件提供了两个导出字段: + +```json +{ + "module": "index.js", + "main": "./dist/simpleMindMap.umd.min.js", +} +``` + +支持`module`字段的环境会以`index.js`为入口,否则会以打包后的`simpleMindMap.umd.min.js`为入口。 + +### 打包demo ```bash cd web @@ -70,15 +90,17 @@ npm run build npm i simple-mind-map ``` -注意:本项目为源码直接发布,并未进行打包,如果出现编译失败的情况,Vue CLI创建的项目可以在vue.config.js文件中增加如下配置来让babel-loader编译本依赖: +`0.2.0`版本之前的注意事项: -```js -module.exports = { - transpileDependencies: ['simple-mind-map'] -} -``` - -其他项目请自行修改打包配置。 +>注意:本项目为源码直接发布,并未进行打包,如果出现编译失败的情况,Vue CLI创建的项目可以在vue.config.js文件中增加如下配置来让babel-loader编译本依赖: +> +>```js +>module.exports = { +> transpileDependencies: ['simple-mind-map'] +>} +>``` +> +>其他项目请自行修改打包配置。 # API diff --git a/simple-mind-map/dist/img/blueSky.3c7f8ccb.jpg b/simple-mind-map/dist/img/blueSky.3c7f8ccb.jpg new file mode 100644 index 00000000..0e4ebc23 Binary files /dev/null and b/simple-mind-map/dist/img/blueSky.3c7f8ccb.jpg differ diff --git a/simple-mind-map/dist/img/brainImpairedPink.511fee22.jpg b/simple-mind-map/dist/img/brainImpairedPink.511fee22.jpg new file mode 100644 index 00000000..62448d3e Binary files /dev/null and b/simple-mind-map/dist/img/brainImpairedPink.511fee22.jpg differ diff --git a/simple-mind-map/dist/img/catalogOrganization.380bb277.jpg b/simple-mind-map/dist/img/catalogOrganization.380bb277.jpg new file mode 100644 index 00000000..7978d11f Binary files /dev/null and b/simple-mind-map/dist/img/catalogOrganization.380bb277.jpg differ diff --git a/simple-mind-map/dist/img/classic.733f273c.jpg b/simple-mind-map/dist/img/classic.733f273c.jpg new file mode 100644 index 00000000..bf6f2490 Binary files /dev/null and b/simple-mind-map/dist/img/classic.733f273c.jpg differ diff --git a/simple-mind-map/dist/img/classic2.cdfe2a8d.jpg b/simple-mind-map/dist/img/classic2.cdfe2a8d.jpg new file mode 100644 index 00000000..c28e30c8 Binary files /dev/null and b/simple-mind-map/dist/img/classic2.cdfe2a8d.jpg differ diff --git a/simple-mind-map/dist/img/classic3.19d6c347.jpg b/simple-mind-map/dist/img/classic3.19d6c347.jpg new file mode 100644 index 00000000..44b1d017 Binary files /dev/null and b/simple-mind-map/dist/img/classic3.19d6c347.jpg differ diff --git a/simple-mind-map/dist/img/classic4.087902fc.jpg b/simple-mind-map/dist/img/classic4.087902fc.jpg new file mode 100644 index 00000000..b95e5d06 Binary files /dev/null and b/simple-mind-map/dist/img/classic4.087902fc.jpg differ diff --git a/simple-mind-map/dist/img/classicBlue.4b8243c6.jpg b/simple-mind-map/dist/img/classicBlue.4b8243c6.jpg new file mode 100644 index 00000000..efbf669a Binary files /dev/null and b/simple-mind-map/dist/img/classicBlue.4b8243c6.jpg differ diff --git a/simple-mind-map/dist/img/classicGreen.c2ae7bde.jpg b/simple-mind-map/dist/img/classicGreen.c2ae7bde.jpg new file mode 100644 index 00000000..4b092a0b Binary files /dev/null and b/simple-mind-map/dist/img/classicGreen.c2ae7bde.jpg differ diff --git a/simple-mind-map/dist/img/dark.894c1d36.jpg b/simple-mind-map/dist/img/dark.894c1d36.jpg new file mode 100644 index 00000000..2d8013ac Binary files /dev/null and b/simple-mind-map/dist/img/dark.894c1d36.jpg differ diff --git a/simple-mind-map/dist/img/dark2.c49dc11c.jpg b/simple-mind-map/dist/img/dark2.c49dc11c.jpg new file mode 100644 index 00000000..aabfec16 Binary files /dev/null and b/simple-mind-map/dist/img/dark2.c49dc11c.jpg differ diff --git a/simple-mind-map/dist/img/default.1312a3ba.jpg b/simple-mind-map/dist/img/default.1312a3ba.jpg new file mode 100644 index 00000000..e90320c3 Binary files /dev/null and b/simple-mind-map/dist/img/default.1312a3ba.jpg differ diff --git a/simple-mind-map/dist/img/earthYellow.c35e546d.jpg b/simple-mind-map/dist/img/earthYellow.c35e546d.jpg new file mode 100644 index 00000000..7bc65c5e Binary files /dev/null and b/simple-mind-map/dist/img/earthYellow.c35e546d.jpg differ diff --git a/simple-mind-map/dist/img/freshGreen.0e344e3e.jpg b/simple-mind-map/dist/img/freshGreen.0e344e3e.jpg new file mode 100644 index 00000000..2c48339a Binary files /dev/null and b/simple-mind-map/dist/img/freshGreen.0e344e3e.jpg differ diff --git a/simple-mind-map/dist/img/freshRed.1c5bde77.jpg b/simple-mind-map/dist/img/freshRed.1c5bde77.jpg new file mode 100644 index 00000000..e5192b78 Binary files /dev/null and b/simple-mind-map/dist/img/freshRed.1c5bde77.jpg differ diff --git a/simple-mind-map/dist/img/gold.3093b3c8.jpg b/simple-mind-map/dist/img/gold.3093b3c8.jpg new file mode 100644 index 00000000..4192a94e Binary files /dev/null and b/simple-mind-map/dist/img/gold.3093b3c8.jpg differ diff --git a/simple-mind-map/dist/img/greenLeaf.6789e8fc.jpg b/simple-mind-map/dist/img/greenLeaf.6789e8fc.jpg new file mode 100644 index 00000000..440b89de Binary files /dev/null and b/simple-mind-map/dist/img/greenLeaf.6789e8fc.jpg differ diff --git a/simple-mind-map/dist/img/logicalStructure.624920ce.jpg b/simple-mind-map/dist/img/logicalStructure.624920ce.jpg new file mode 100644 index 00000000..998922a4 Binary files /dev/null and b/simple-mind-map/dist/img/logicalStructure.624920ce.jpg differ diff --git a/simple-mind-map/dist/img/mindMap.223b38aa.jpg b/simple-mind-map/dist/img/mindMap.223b38aa.jpg new file mode 100644 index 00000000..9a35f185 Binary files /dev/null and b/simple-mind-map/dist/img/mindMap.223b38aa.jpg differ diff --git a/simple-mind-map/dist/img/minions.c2a93f9e.jpg b/simple-mind-map/dist/img/minions.c2a93f9e.jpg new file mode 100644 index 00000000..a148ca79 Binary files /dev/null and b/simple-mind-map/dist/img/minions.c2a93f9e.jpg differ diff --git a/simple-mind-map/dist/img/mint.7933f60a.jpg b/simple-mind-map/dist/img/mint.7933f60a.jpg new file mode 100644 index 00000000..4f6f72b4 Binary files /dev/null and b/simple-mind-map/dist/img/mint.7933f60a.jpg differ diff --git a/simple-mind-map/dist/img/organizationStructure.8064f4da.jpg b/simple-mind-map/dist/img/organizationStructure.8064f4da.jpg new file mode 100644 index 00000000..0159e807 Binary files /dev/null and b/simple-mind-map/dist/img/organizationStructure.8064f4da.jpg differ diff --git a/simple-mind-map/dist/img/pinkGrape.32c2587b.jpg b/simple-mind-map/dist/img/pinkGrape.32c2587b.jpg new file mode 100644 index 00000000..b82999a2 Binary files /dev/null and b/simple-mind-map/dist/img/pinkGrape.32c2587b.jpg differ diff --git a/simple-mind-map/dist/img/romanticPurple.7607e58a.jpg b/simple-mind-map/dist/img/romanticPurple.7607e58a.jpg new file mode 100644 index 00000000..2a358966 Binary files /dev/null and b/simple-mind-map/dist/img/romanticPurple.7607e58a.jpg differ diff --git a/simple-mind-map/dist/img/skyGreen.4cfa829a.jpg b/simple-mind-map/dist/img/skyGreen.4cfa829a.jpg new file mode 100644 index 00000000..76a0c1d0 Binary files /dev/null and b/simple-mind-map/dist/img/skyGreen.4cfa829a.jpg differ diff --git a/simple-mind-map/dist/img/vitalityOrange.5dd9014f.jpg b/simple-mind-map/dist/img/vitalityOrange.5dd9014f.jpg new file mode 100644 index 00000000..8fc9c922 Binary files /dev/null and b/simple-mind-map/dist/img/vitalityOrange.5dd9014f.jpg differ diff --git a/simple-mind-map/package.json b/simple-mind-map/package.json index fb2e013a..68579cd0 100644 --- a/simple-mind-map/package.json +++ b/simple-mind-map/package.json @@ -18,8 +18,8 @@ "url": "https://github.com/wanglin2/mind-map" }, "scripts": {}, - "main": "index.js", - "type": "module", + "module": "index.js", + "main": "./dist/simpleMindMap.umd.min.js", "dependencies": { "@svgdotjs/svg.js": "^3.0.16", "canvg": "^3.0.7", diff --git a/web/package.json b/web/package.json index 60278536..1315a3b5 100644 --- a/web/package.json +++ b/web/package.json @@ -5,7 +5,8 @@ "scripts": { "serve": "vue-cli-service serve", "build": "vue-cli-service build && node ../copy.js", - "lint": "vue-cli-service lint" + "lint": "vue-cli-service lint", + "buildLibrary": "vue-cli-service build --target lib --name simpleMindMap ../simple-mind-map/index.js --dest ../simple-mind-map/dist" }, "dependencies": { "@toast-ui/editor": "^3.1.5",