Skip to content

Commit

Permalink
update docs for v1.10.0
Browse files Browse the repository at this point in the history
  • Loading branch information
mindolph committed Nov 11, 2024
1 parent 25ea9fc commit b8de068
Show file tree
Hide file tree
Showing 6 changed files with 55 additions and 18 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,10 @@ Mindolph is an open source personal knowledge management software for all deskto
### Features
* Create and manage your own files in separate workspaces with saving in your local storage, which means you have full control of your knowledge compared to cloud solutions.
* Organize your files as tree in your workspaces.
* Save opened files as a named `Collection` to manage related files even from different workspaces.
* Multiple tabs for opening files instead of a single file window, making it easy to switch back and forth between files.
* Supports Mind Map(`*.mmd`), Markdown(`*.md`), PlantUML(`*.puml`), CSV sheet(`*.csv`) and plain text(`*.txt`) file formats, more formats will be supported in the future.
* Outline view for active opend file.
* Quickly navigate to file and search text in files under specific folder.
* Mind Map:
* Edit mind map easily and quickly with key shortcuts.
Expand Down Expand Up @@ -76,13 +78,13 @@ Mindolph is an open source personal knowledge management software for all deskto

|Platform|Type|Stable|Unstable|Note|
|----|----|----|----|----|
|| |[v1.9.x](docs/release-notes/v1.9/v1.9.md)|[v1.9.x](docs/release-notes/v1.9/v1.9.md)| Release notes |
|macOS|.dmg|[v1.9.4](https://github.com/mindolph/Mindolph/releases/download/v1.9.4/Mindolph-1.9.4-x64.dmg) |[v1.9.3](https://github.com/mindolph/Mindolph/releases/download/v1.9.3/Mindolph-1.9.3-x64.dmg) | Intel |
|macOS|.dmg|[v1.9.4](https://github.com/mindolph/Mindolph/releases/download/v1.9.4/Mindolph-1.9.4-aarch64.dmg) |[v1.9.3](https://github.com/mindolph/Mindolph/releases/download/v1.9.3/Mindolph-1.9.3-aarch64.dmg) | Apple Silicon </br>for supporting PlantUML, install graphviz first:</br>`brew install graphviz`|
|Windows|.msi|[v1.9.4](https://github.com/mindolph/Mindolph/releases/download/v1.9.4/Mindolph-1.9.4.msi) |[v1.9.3](https://github.com/mindolph/Mindolph/releases/download/v1.9.3/Mindolph-1.9.3.msi) | |
|Debian|.deb|[v1.9.4](https://github.com/mindolph/Mindolph/releases/download/v1.9.4/Mindolph-1.9.4.deb)|[v1.9.3](https://github.com/mindolph/Mindolph/releases/download/v1.9.3/Mindolph-1.9.3.deb)| for supporting PlantUML, install graphviz first:</br> `sudo apt install graphviz`|
|Fedora|.rpm|[v1.9.4](https://github.com/mindolph/Mindolph/releases/download/v1.9.4/Mindolph-1.9.4.rpm)|[v1.9.3](https://github.com/mindolph/Mindolph/releases/download/v1.9.3/Mindolph-1.9.3.rpm)| |
|Java Executable|.jar|[v1.9.4](https://github.com/mindolph/Mindolph/releases/download/v1.9.4/Mindolph-1.9.4.jar)|[v1.9.3](https://github.com/mindolph/Mindolph/releases/download/v1.9.3/Mindolph-1.9.3.jar)| Java 17 is the minimum version to run this application. </br> If you are using Linux, run the jar like this: </br> `java -jar Mindolph-1.9.4.jar` </br> If not, Download latest JavaFX SDK for your platform and extract to somewhere eg: `c:\javafx-sdk-22`, run the jar file like this: </br> `java --module-path c:\javafx-sdk-22\lib --add-modules java.sql,javafx.controls,javafx.fxml,javafx.swing,javafx.web,jdk.crypto.ec -jar Mindolph-1.9.4.jar` |
|| |[v1.9.x](docs/release-notes/v1.9/v1.9.md)|[v1.10.x](docs/release-notes/v1.10/v1.10.md)| Release notes |
|macOS|.dmg|[v1.9.4](https://github.com/mindolph/Mindolph/releases/download/v1.9.4/Mindolph-1.9.4-x64.dmg) |[v1.10.0](https://github.com/mindolph/Mindolph/releases/download/v1.10.0/Mindolph-1.10.0-x64.dmg) | Intel |
|macOS|.dmg|[v1.9.4](https://github.com/mindolph/Mindolph/releases/download/v1.9.4/Mindolph-1.9.4-aarch64.dmg) |[v1.10.0](https://github.com/mindolph/Mindolph/releases/download/v1.10.0/Mindolph-1.10.0-aarch64.dmg) | Apple Silicon </br>for supporting PlantUML, install graphviz first:</br>`brew install graphviz`|
|Windows|.msi|[v1.9.4](https://github.com/mindolph/Mindolph/releases/download/v1.9.4/Mindolph-1.9.4.msi) |[v1.10.0](https://github.com/mindolph/Mindolph/releases/download/v1.10.0/Mindolph-1.10.0.msi) | |
|Debian|.deb|[v1.9.4](https://github.com/mindolph/Mindolph/releases/download/v1.9.4/Mindolph-1.9.4.deb)|[v1.10.0](https://github.com/mindolph/Mindolph/releases/download/v1.10.0/Mindolph-1.10.0.deb)| for supporting PlantUML, install graphviz first:</br> `sudo apt install graphviz`|
|Fedora|.rpm|[v1.9.4](https://github.com/mindolph/Mindolph/releases/download/v1.9.4/Mindolph-1.9.4.rpm)|[v1.10.0](https://github.com/mindolph/Mindolph/releases/download/v1.10.0/Mindolph-1.10.0.rpm)| |
|Java Executable|.jar|[v1.9.4](https://github.com/mindolph/Mindolph/releases/download/v1.9.4/Mindolph-1.9.4.jar)|[v1.10.0](https://github.com/mindolph/Mindolph/releases/download/v1.10.0/Mindolph-1.10.0.jar)| Java 17 is the minimum version to run this application. </br> If you are using Linux, run the jar like this: </br> `java -jar Mindolph-1.9.4.jar` </br> If not, Download latest JavaFX SDK for your platform and extract to somewhere eg: `c:\javafx-sdk-22`, run the jar file like this: </br> `java --module-path c:\javafx-sdk-22\lib --add-modules java.sql,javafx.controls,javafx.fxml,javafx.swing,javafx.web,jdk.crypto.ec -jar Mindolph-1.9.4.jar` |


[Change Logs](docs/change_logs.md)
Expand All @@ -93,9 +95,8 @@ Mindolph is an open source personal knowledge management software for all deskto
Mindolph is developed based on JavaFX, see [code/README.md](code/README.md) for more details.

Future Plan:

* 1.9: File Collection and Outline.
* 1.10: Snippet Feature to quickly insert snippet for many file types.
* 1.11: Improment and bug fixing.

### Buy me a cup of coffee

Expand Down
18 changes: 10 additions & 8 deletions docs/README_zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,10 @@ Mindolph 是一个开源的支持多种桌面平台的个人知识库管理软
### 功能
* 可以创建多个工作空间来管理您的文件。并且文件保存在您本机的存储上,相较于基于云的方案,您拥有对它们完全的掌控。
* 工作空间采用树形目录结构来组织文件。
* 可以把打开的文件保存为一个集合(`Collection`),哪怕文件位于不同的工作空间。
* 多标签页打开文件而不是单文件窗口,可以方便的在多个文件之间来回切换。
* 支持思维导图(`*.mmd`), Markdown(`*.md`), PlantUML(`*.puml`), CSV 表格(`*.csv`) 以及纯文本(`*.txt`)等多种文件格式,后续还会支持更多格式。
* 支持文件大纲视图。
* 快速导航并打开文件,以及在任意文件夹下搜索包含指定内容的文件。
* 思维导图:
* 支持快捷键可以轻松的编辑思维导图。
Expand Down Expand Up @@ -77,13 +79,13 @@ Mindolph 是一个开源的支持多种桌面平台的个人知识库管理软

|系统|类型|稳定版|不稳定版|备注|
|----|----|----|----|----|
|| |[v1.9.x](release-notes/v1.9/v1.9_zh_CN.md)|[v1.9.x](release-notes/v1.9/v1.9_zh_CN.md)| 发布记录 |
|macOS|.dmg|[v1.9.4](https://github.com/mindolph/Mindolph/releases/download/v1.9.4/Mindolph-1.9.4-x64.dmg)|[v1.9.3](https://github.com/mindolph/Mindolph/releases/download/v1.9.3/Mindolph-1.9.3-x64.dmg)| Intel |
|macOS|.dmg|[v1.9.4](https://github.com/mindolph/Mindolph/releases/download/v1.9.4/Mindolph-1.9.4-aarch64.dmg) |[v1.9.3](https://github.com/mindolph/Mindolph/releases/download/v1.9.3/Mindolph-1.9.3-aarch64.dmg) | Apple Silicon </br>显示 PlantUML 图需要先安装 graphviz:</br>`brew install graphviz`|
|Windows|.msi|[v1.9.4](https://github.com/mindolph/Mindolph/releases/download/v1.9.4/Mindolph-1.9.4.msi)|[v1.9.3](https://github.com/mindolph/Mindolph/releases/download/v1.9.3/Mindolph-1.9.3.msi)| |
|Debian|.deb|[v1.9.4](https://github.com/mindolph/Mindolph/releases/download/v1.9.4/Mindolph-1.9.4.deb)|[v1.9.3](https://github.com/mindolph/Mindolph/releases/download/v1.9.3/Mindolph-1.9.3.deb)| 显示 PlantUML 图需要先安装 graphviz: </br> `sudo apt install graphviz`|
|Fedora|.rpm|[v1.9.4](https://github.com/mindolph/Mindolph/releases/download/v1.9.4/Mindolph-1.9.4.rpm)|[v1.9.3](https://github.com/mindolph/Mindolph/releases/download/v1.9.3/Mindolph-1.9.3.rpm)| |
|Java Executable|.jar|[v1.9.4](https://github.com/mindolph/Mindolph/releases/download/v1.9.4/Mindolph-1.9.4.jar)|[v1.9.3](https://github.com/mindolph/Mindolph/releases/download/v1.9.3/Mindolph-1.9.3.jar)| Java 17 是运行 Mindolph 的最低版本要求. </br> 如果您在 Linux 上运行: </br> `java -jar Mindolph-1.9.4.jar` </br> 如果是其他系统, 先下载支持您的系统的 JavaFX SDK 并解压缩到某个目录,例如: `c:\javafx-sdk-22`, 按照以下方式运行: </br>`java --module-path c:\javafx-sdk-22\lib --add-modules java.sql,javafx.controls,javafx.fxml,javafx.swing,javafx.web,jdk.crypto.ec -jar Mindolph-1.9.4.jar` |
|| |[v1.9.x](release-notes/v1.9/v1.9_zh_CN.md)|[v1.10.x](release-notes/v1.10/v1.10_zh_CN.md)| 发布记录 |
|macOS|.dmg|[v1.9.4](https://github.com/mindolph/Mindolph/releases/download/v1.9.4/Mindolph-1.9.4-x64.dmg)|[v1.10.0](https://github.com/mindolph/Mindolph/releases/download/v1.10.0/Mindolph-1.10.0-x64.dmg)| Intel |
|macOS|.dmg|[v1.9.4](https://github.com/mindolph/Mindolph/releases/download/v1.9.4/Mindolph-1.9.4-aarch64.dmg) |[v1.10.0](https://github.com/mindolph/Mindolph/releases/download/v1.10.0/Mindolph-1.10.0-aarch64.dmg) | Apple Silicon </br>显示 PlantUML 图需要先安装 graphviz:</br>`brew install graphviz`|
|Windows|.msi|[v1.9.4](https://github.com/mindolph/Mindolph/releases/download/v1.9.4/Mindolph-1.9.4.msi)|[v1.10.0](https://github.com/mindolph/Mindolph/releases/download/v1.10.0/Mindolph-1.10.0.msi)| |
|Debian|.deb|[v1.9.4](https://github.com/mindolph/Mindolph/releases/download/v1.9.4/Mindolph-1.9.4.deb)|[v1.10.0](https://github.com/mindolph/Mindolph/releases/download/v1.10.0/Mindolph-1.10.0.deb)| 显示 PlantUML 图需要先安装 graphviz: </br> `sudo apt install graphviz`|
|Fedora|.rpm|[v1.9.4](https://github.com/mindolph/Mindolph/releases/download/v1.9.4/Mindolph-1.9.4.rpm)|[v1.10.0](https://github.com/mindolph/Mindolph/releases/download/v1.10.0/Mindolph-1.10.0.rpm)| |
|Java Executable|.jar|[v1.9.4](https://github.com/mindolph/Mindolph/releases/download/v1.9.4/Mindolph-1.9.4.jar)|[v1.10.0](https://github.com/mindolph/Mindolph/releases/download/v1.10.0/Mindolph-1.10.0.jar)| Java 17 是运行 Mindolph 的最低版本要求. </br> 如果您在 Linux 上运行: </br> `java -jar Mindolph-1.9.4.jar` </br> 如果是其他系统, 先下载支持您的系统的 JavaFX SDK 并解压缩到某个目录,例如: `c:\javafx-sdk-22`, 按照以下方式运行: </br>`java --module-path c:\javafx-sdk-22\lib --add-modules java.sql,javafx.controls,javafx.fxml,javafx.swing,javafx.web,jdk.crypto.ec -jar Mindolph-1.9.4.jar` |



Expand All @@ -95,8 +97,8 @@ Mindolph 是基于 JavaFX 开发的, 更多详情请点击[code/README.md](../co

计划:

* 1.9: 文件集合和大纲。
* 1.10:全局的代码片段快速插入功能。
* 1.11:功能改进和bug修复

### 给我买杯咖啡吧

Expand Down
9 changes: 9 additions & 0 deletions docs/change_logs.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Change Logs


### V1.10.0 Unstable Release

* Feature: new snippet panel for all files; move PlantUML snippets to the global snippet panel.
* Feature: add snippet support for mind map by emoticons.
* Improvement: refactored the emoticon dialog with new version emoticon view.
* Fix: locating folder from `go to file` dialog doesn't work if `auto select` option is disabled by user.


### V1.9.4 Release

* Improvement: `remove collection` menu item should be disabled for `default` collection.
Expand Down
20 changes: 20 additions & 0 deletions docs/release-notes/v1.10/v1.10.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# v1.10 Release Note(Draft)

### New Features

* new snippet panel for all files; move PlantUML snippets to the global snippet panel.
* add snippet support for mind map by emoticons.


### Improvement
* refactored the emoticon dialog with new version emoticon view.


### Bug Fixes
* locating folder from `go to file` dialog doesn't work if `auto select` option is disabled by user.


### Dependencies

---
> Created at 2024-11-12 00:59:13
5 changes: 5 additions & 0 deletions docs/release-notes/v1.10/v1.10_zh_CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# v1.10_zh_CN


---
> Created at 2024-11-12 00:59:23
2 changes: 1 addition & 1 deletion docs/release-notes/v1.9/v1.9.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
* PlantUML
![v1.9_outline_puml.jpg](v1.9_outline_puml.jpg)

### Improvement:
### Improvement

* The displaying of tabs on the left side panel is minimized since the outline view is introduced.

Expand Down

0 comments on commit b8de068

Please sign in to comment.