diff --git a/README.md b/README.md index 08eda5bc..6b76ad40 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,8 @@ Github:[releases](https://github.com/wanglin2/mind-map/releases)。 百度云盘:[地址](https://pan.baidu.com/s/1huasEbKsGNH2Af68dvWiOg?pwd=3bp3)。 +> 客户端版本会落后于在线版本,尝试最新功能请优先使用在线版。 + # 特性 - [x] 插件化架构,除核心功能外,其他功能作为插件提供,按需使用,减小打包体积 @@ -183,4 +185,8 @@ const mindMap = new MindMap({ + + + 沐风牧草 +

\ No newline at end of file diff --git a/web/src/assets/avatar/沐风牧草.jpg b/web/src/assets/avatar/沐风牧草.jpg new file mode 100644 index 00000000..201827a1 Binary files /dev/null and b/web/src/assets/avatar/沐风牧草.jpg differ diff --git a/web/src/pages/Doc/en/client/index.md b/web/src/pages/Doc/en/client/index.md new file mode 100644 index 00000000..406afa6f --- /dev/null +++ b/web/src/pages/Doc/en/client/index.md @@ -0,0 +1,82 @@ +# Client + +This project also provides a client version using [Electron](https://www.electronjs.org/) Development. Supports 'Windows', 'Mac', and 'Linux'. + +Currently, the function is relatively simple: + +1. Support creating and opening files for editing; + +2. Support viewing the list of recently edited files; + +3. Support the copying, deletion, and renaming of files; + +## Download + +> The client version may lag behind the online version. To try new features, please prioritize using the online version. + +You can directly download the corresponding client for installation and use, and two download addresses are provided: + +Github:[releases](https://github.com/wanglin2/mind-map/releases)。 + +Baidu cloud disk:[地址](https://pan.baidu.com/s/1huasEbKsGNH2Af68dvWiOg?pwd=3bp3)。 + +## Development + +If necessary, you can also conduct secondary development. + +### clone + +```bash +git clone https://github.com/wanglin2/mind-map.git +cd mind-map +git checkout electron +``` + +### Start serve + +Execute in the project root directory: + +```bash +cd simple-mind-map +npm i +npm link +cd .. +cd web +npm i +npm link simple-mind-map +npm run electron:serve +``` + +### Packaging client + +You need at least two computers, one 'Windows' and one 'Mac'. + +Packaging 'Windows' application: + +```bash +npm run electron:build-win +``` + +Packaging 'Mac' application: + +```bash +npm run electron:build-mac +``` + +Packaging 'Linux' application: + +```bash +npm run electron:build-linux +``` + +Packaging all applications: + +```bash +npm run electron:build-all +``` + +Automatically pack according to your computer system: + +```bash +npm run electron:build +``` \ No newline at end of file diff --git a/web/src/pages/Doc/en/client/index.vue b/web/src/pages/Doc/en/client/index.vue new file mode 100644 index 00000000..c5770804 --- /dev/null +++ b/web/src/pages/Doc/en/client/index.vue @@ -0,0 +1,71 @@ + + + + + \ No newline at end of file diff --git a/web/src/pages/Doc/en/introduction/index.md b/web/src/pages/Doc/en/introduction/index.md index 324e9170..4a35e93f 100644 --- a/web/src/pages/Doc/en/introduction/index.md +++ b/web/src/pages/Doc/en/introduction/index.md @@ -206,4 +206,8 @@ Open source is not easy. If this project is helpful to you, you can invite the a

+
+ +

沐风牧草

+
\ No newline at end of file diff --git a/web/src/pages/Doc/en/introduction/index.vue b/web/src/pages/Doc/en/introduction/index.vue index 053338f7..26077b8b 100644 --- a/web/src/pages/Doc/en/introduction/index.vue +++ b/web/src/pages/Doc/en/introduction/index.vue @@ -8,16 +8,16 @@

Features

Repository Catalog Introduction

1.simple-mind-map

@@ -27,16 +27,16 @@ frameworks such as Vue and React, or without a framework.

This is an online mind map built using the simple-mind-map library and based on Vue2.x and ElementUI. Features include:

@@ -164,6 +164,10 @@ full screen, support mini map

+
+ +

沐风牧草

+
diff --git a/web/src/pages/Doc/en/translate/index.md b/web/src/pages/Doc/en/translate/index.md index 3255000e..732939a1 100644 --- a/web/src/pages/Doc/en/translate/index.md +++ b/web/src/pages/Doc/en/translate/index.md @@ -1,4 +1,12 @@ -# Participate in translation +# Contribute + +## Participate in development + +If you want to contribute code, you can 'fork' this project and switch to the 'feature' branch for development. After development and testing, you can submit the 'pr' to the 'feature' branch of this project. When submitting, please try to submit functional files as much as possible. Do not submit unnecessary files. + +Before development, it is best to create a new 'issue' to describe the new features you want to add. We can have sufficient communication first, and when submitting a 'pr', please provide a detailed description of the features you are developing. + +## Participate in translation > Thanks for the first version English translation provided by [Emircan ERKUL](https://github.com/emircanerkul). > diff --git a/web/src/pages/Doc/en/translate/index.vue b/web/src/pages/Doc/en/translate/index.vue index 8c07be6b..9df8cc99 100644 --- a/web/src/pages/Doc/en/translate/index.vue +++ b/web/src/pages/Doc/en/translate/index.vue @@ -1,6 +1,10 @@ diff --git a/web/src/pages/Doc/zh/translate/index.md b/web/src/pages/Doc/zh/translate/index.md index e5fe5d79..3a415abe 100644 --- a/web/src/pages/Doc/zh/translate/index.md +++ b/web/src/pages/Doc/zh/translate/index.md @@ -1,4 +1,12 @@ -# 参与翻译 +# 贡献 + +## 参与开发 + +如果你想贡献代码的话可以`fork`本项目,然后切换到`feature`分支下进行开发,开发并测试完后可以提交`pr`到本项目的`feature`分支,提交时请尽量提交功能相关的文件,非必要的文件请勿提交。 + +在开发前最好通过新建一个`issue`来描述你想要新增的功能,我们可以先进行充分的沟通,在提交`pr`时请详细描述你开发的功能。 + +## 参与翻译 > 感谢[Emircan ERKUL](https://github.com/emircanerkul)提供的第一版英文翻译。 > diff --git a/web/src/pages/Doc/zh/translate/index.vue b/web/src/pages/Doc/zh/translate/index.vue index e4e10473..9507ef9a 100644 --- a/web/src/pages/Doc/zh/translate/index.vue +++ b/web/src/pages/Doc/zh/translate/index.vue @@ -1,6 +1,10 @@