Skip to content

Commit

Permalink
update docs for v1.7.2
Browse files Browse the repository at this point in the history
  • Loading branch information
@mindolph
mindolph committed Mar 16, 2024
1 parent f6339df commit 0513a2f
Show file tree
Hide file tree
Showing 5 changed files with 73 additions and 60 deletions.
21 changes: 10 additions & 11 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Mindolph is an open source personal knowledge management software for all deskto
* Mind Map:
* Edit mind map easily and quickly with key shortcuts.
* Supports theme and provides some pre-defined themes(`Classic`, `Light` and `Dark`), customizing themes by duplicating existing theme and setup style of any element freely.
* Supports note, file link, URI link, image and emoticon for topic node.
* Supports note, file link, URI link, image and emoticon for topic node.
* Import from other mind map formats like Freemind, Mindmup, XMind, Coggle, Novamind.
* Export to other file formats like Freemind, Markdown, image file(png/svg), AsciiDoc, etc.
* Compatible with files created by `netbeans-mmd-plugin`.
Expand Down Expand Up @@ -70,23 +70,22 @@ Mindolph is an open source personal knowledge management software for all deskto
|Platform|Type|Stable|Unstable|Note|
|----|----|----|----|----|
|Release Notes| |[v1.6.x](docs/release-notes/v1.6/v1.6.md)|[v1.7.x](docs/release-notes/v1.7/v1.7.md)| |
|macOS|.dmg|[v1.6.11](https://github.com/mindolph/Mindolph/releases/download/v1.6.11/Mindolph-1.6.11.dmg) |[v1.7.1](https://github.com/mindolph/Mindolph/releases/download/v1.7.1/Mindolph-1.7.1.dmg) | Intel |
|macOS|.dmg|[v1.6.11](https://github.com/mindolph/Mindolph/releases/download/v1.6.11/Mindolph-1.6.11-aarch64.dmg) |[v1.7.1](https://github.com/mindolph/Mindolph/releases/download/v1.7.1/Mindolph-1.7.1-aarch64.dmg) | Apple Silicon |
|Windows|.msi|[v1.6.11](https://github.com/mindolph/Mindolph/releases/download/v1.6.11/Mindolph-1.6.11.msi) |[v1.7.1](https://github.com/mindolph/Mindolph/releases/download/v1.7.1/Mindolph-1.7.1.msi) | |
|Debian|.deb|[v1.6.11](https://github.com/mindolph/Mindolph/releases/download/v1.6.11/Mindolph-1.6.11.deb)|[v1.7.1](https://github.com/mindolph/Mindolph/releases/download/v1.7.1/Mindolph-1.7.1.deb)| for supporting PlantUML, install graphviz first:</br> `sudo apt install graphviz`|
|Fedora|.rpm|[v1.6.11](https://github.com/mindolph/Mindolph/releases/download/v1.6.11/Mindolph-1.6.11.rpm)|[v1.7.1](https://github.com/mindolph/Mindolph/releases/download/v1.7.1/Mindolph-1.7.1.rpm)| |
|Java Executable|.jar|[v1.6.11](https://github.com/mindolph/Mindolph/releases/download/v1.6.11/Mindolph-1.6.11.jar)|[v1.7.1](https://github.com/mindolph/Mindolph/releases/download/v1.7.1/Mindolph-1.7.1.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.6.11.jar` </br> If not, Download latest JavaFX SDK for your platform and extract to somewhere eg: `c:\javafx-sdk-21`, run the jar file like this: </br> `java --module-path c:\javafx-sdk-21\lib --add-modules java.sql,javafx.controls,javafx.fxml,javafx.swing,javafx.web,jdk.crypto.ec -jar Mindolph-1.6.11.jar` |
|macOS|.dmg|[v1.6.11](https://github.com/mindolph/Mindolph/releases/download/v1.6.11/Mindolph-1.6.11.dmg) |[v1.7.2](https://github.com/mindolph/Mindolph/releases/download/v1.7.2/Mindolph-1.7.2.dmg) | Intel |
|macOS|.dmg|[v1.6.11](https://github.com/mindolph/Mindolph/releases/download/v1.6.11/Mindolph-1.6.11-aarch64.dmg) |[v1.7.2](https://github.com/mindolph/Mindolph/releases/download/v1.7.2/Mindolph-1.7.2-aarch64.dmg) | Apple Silicon |
|Windows|.msi|[v1.6.11](https://github.com/mindolph/Mindolph/releases/download/v1.6.11/Mindolph-1.6.11.msi) |[v1.7.2](https://github.com/mindolph/Mindolph/releases/download/v1.7.2/Mindolph-1.7.2.msi) | |
|Debian|.deb|[v1.6.11](https://github.com/mindolph/Mindolph/releases/download/v1.6.11/Mindolph-1.6.11.deb)|[v1.7.2](https://github.com/mindolph/Mindolph/releases/download/v1.7.2/Mindolph-1.7.2.deb)| for supporting PlantUML, install graphviz first:</br> `sudo apt install graphviz`|
|Fedora|.rpm|[v1.6.11](https://github.com/mindolph/Mindolph/releases/download/v1.6.11/Mindolph-1.6.11.rpm)|[v1.7.2](https://github.com/mindolph/Mindolph/releases/download/v1.7.2/Mindolph-1.7.2.rpm)| |
|Java Executable|.jar|[v1.6.11](https://github.com/mindolph/Mindolph/releases/download/v1.6.11/Mindolph-1.6.11.jar)|[v1.7.2](https://github.com/mindolph/Mindolph/releases/download/v1.7.2/Mindolph-1.7.2.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.6.11.jar` </br> If not, Download latest JavaFX SDK for your platform and extract to somewhere eg: `c:\javafx-sdk-21`, run the jar file like this: </br> `java --module-path c:\javafx-sdk-21\lib --add-modules java.sql,javafx.controls,javafx.fxml,javafx.swing,javafx.web,jdk.crypto.ec -jar Mindolph-1.6.11.jar` |


[Change Logs](docs/change_logs.md)


### Development

Mindolph is developed based on JavaFX,
see [code/README.md](code/README.md) for more details.
Mindolph is developed based on JavaFX, see [code/README.md](code/README.md) for more details.

Future Plan:

Future Plan:
* 1.7: Experimental GenAI support.
* 1.8: Improvement and refactor.

22 changes: 11 additions & 11 deletions docs/README_zh_CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Mindolph 是一个开源的支持多种桌面平台的个人知识库管理软
* 工作空间采用树形目录结构来组织文件。
* 多标签页打开文件而不是单文件窗口，可以方便的在多个文件之间来回切换。
* 支持思维导图(`*.mmd`), Markdown(`*.md`), PlantUML(`*.puml`), CSV 表格(`*.csv`) 以及纯文本(`*.txt`)等多种文件格式，后续还会支持更多格式。
* 快速导航并打开文件，以及在任意文件夹下搜索包含指定内容的文件。
* 快速导航并打开文件，以及在任意文件夹下搜索包含指定内容的文件。
* 思维导图:
* 支持快捷键可以轻松的编辑思维导图。
* 支持主题并提供了预定义的主题 (`Classic`, `Light` 和 `Dark`)，通过复制已有的主题并自由的设定思维导图各元素的样式来定制主题。
Expand Down Expand Up @@ -71,22 +71,22 @@ Mindolph 是一个开源的支持多种桌面平台的个人知识库管理软
|系统|类型|稳定版|不稳定版|备注|
|----|----|----|----|----|
|发布记录| |[v1.6.x](release-notes/v1.6/v1.6_zh_CN.md)|[v1.7.x](release-notes/v1.7/v1.7.md)| |
|macOS|.dmg|[v1.6.11](https://github.com/mindolph/Mindolph/releases/download/v1.6.11/Mindolph-1.6.11.dmg)|[v1.7.1](https://github.com/mindolph/Mindolph/releases/download/v1.7.1/Mindolph-1.7.1.dmg)| Intel |
|macOS|.dmg|[v1.6.11](https://github.com/mindolph/Mindolph/releases/download/v1.6.11/Mindolph-1.6.11-aarch64.dmg) |[v1.7.1](https://github.com/mindolph/Mindolph/releases/download/v1.7.1/Mindolph-1.7.1-aarch64.dmg) | Apple Silicon |
|Windows|.msi|[v1.6.11](https://github.com/mindolph/Mindolph/releases/download/v1.6.11/Mindolph-1.6.11.msi)|[v1.7.1](https://github.com/mindolph/Mindolph/releases/download/v1.7.1/Mindolph-1.7.1.msi)| |
|Debian|.deb|[v1.6.11](https://github.com/mindolph/Mindolph/releases/download/v1.6.11/Mindolph-1.6.11.deb)|[v1.7.1](https://github.com/mindolph/Mindolph/releases/download/v1.7.1/Mindolph-1.7.1.deb)| 显示 PlantUML 图需要先安装 graphviz: </br> `sudo apt install graphviz`|
|Fedora|.rpm|[v1.6.11](https://github.com/mindolph/Mindolph/releases/download/v1.6.11/Mindolph-1.6.11.rpm)|[v1.7.1](https://github.com/mindolph/Mindolph/releases/download/v1.7.1/Mindolph-1.7.1.rpm)| |
|Java Executable|.jar|[v1.6.11](https://github.com/mindolph/Mindolph/releases/download/v1.6.11/Mindolph-1.6.11.jar)|[v1.7.1](https://github.com/mindolph/Mindolph/releases/download/v1.7.1/Mindolph-1.7.1.jar)| Java 17 是运行 Mindolph 的最低版本要求. </br> 如果您在 Linux 上运行: </br> `java -jar Mindolph-1.6.11.jar` </br> 如果是其他系统, 先下载支持您的系统的 JavaFX SDK 并解压缩到某个目录，例如: `c:\javafx-sdk-20`, 按照以下方式运行: </br>`java --module-path c:\javafx-sdk-20\lib --add-modules java.sql,javafx.controls,javafx.fxml,javafx.swing,javafx.web,jdk.crypto.ec -jar Mindolph-1.6.11.jar` |
|macOS|.dmg|[v1.6.11](https://github.com/mindolph/Mindolph/releases/download/v1.6.11/Mindolph-1.6.11.dmg)|[v1.7.2](https://github.com/mindolph/Mindolph/releases/download/v1.7.2/Mindolph-1.7.2.dmg)| Intel |
|macOS|.dmg|[v1.6.11](https://github.com/mindolph/Mindolph/releases/download/v1.6.11/Mindolph-1.6.11-aarch64.dmg) |[v1.7.2](https://github.com/mindolph/Mindolph/releases/download/v1.7.2/Mindolph-1.7.2-aarch64.dmg) | Apple Silicon |
|Windows|.msi|[v1.6.11](https://github.com/mindolph/Mindolph/releases/download/v1.6.11/Mindolph-1.6.11.msi)|[v1.7.2](https://github.com/mindolph/Mindolph/releases/download/v1.7.2/Mindolph-1.7.2.msi)| |
|Debian|.deb|[v1.6.11](https://github.com/mindolph/Mindolph/releases/download/v1.6.11/Mindolph-1.6.11.deb)|[v1.7.2](https://github.com/mindolph/Mindolph/releases/download/v1.7.2/Mindolph-1.7.2.deb)| 显示 PlantUML 图需要先安装 graphviz: </br> `sudo apt install graphviz`|
|Fedora|.rpm|[v1.6.11](https://github.com/mindolph/Mindolph/releases/download/v1.6.11/Mindolph-1.6.11.rpm)|[v1.7.2](https://github.com/mindolph/Mindolph/releases/download/v1.7.2/Mindolph-1.7.2.rpm)| |
|Java Executable|.jar|[v1.6.11](https://github.com/mindolph/Mindolph/releases/download/v1.6.11/Mindolph-1.6.11.jar)|[v1.7.2](https://github.com/mindolph/Mindolph/releases/download/v1.7.2/Mindolph-1.7.2.jar)| Java 17 是运行 Mindolph 的最低版本要求. </br> 如果您在 Linux 上运行: </br> `java -jar Mindolph-1.6.11.jar` </br> 如果是其他系统, 先下载支持您的系统的 JavaFX SDK 并解压缩到某个目录，例如: `c:\javafx-sdk-20`, 按照以下方式运行: </br>`java --module-path c:\javafx-sdk-20\lib --add-modules java.sql,javafx.controls,javafx.fxml,javafx.swing,javafx.web,jdk.crypto.ec -jar Mindolph-1.6.11.jar` |



[版本日志](change_logs.md)


### 开发
Mindolph 是基于 JavaFX 开发的,
更多详情请点击[code/README.md](../code/README.md)
Mindolph 是基于 JavaFX 开发的, 更多详情请点击[code/README.md](../code/README.md)

计划:
* 1.7: 生成式AI支持（实验性）。
计划:

* 1.7: 生成式AI支持（实验性）
* 1.8: 功能优化和重构。
74 changes: 41 additions & 33 deletions docs/change_logs.md
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,22 @@
# Change Logs

### V1.7.1 Unstable release
### V1.7.2 Unstable Release
* Feature: add Ali Qwen as new LLM provider.
* Improvement: optimized ai generated content.
* Fix: buttons are not restored after exceptions in gen-ai dialog.
* Fix: should show warning dialog instead of exception dialog when try to generate content without gen-ai provider set up.
* Update langchain4j to 0.28 and other dependencies.


### V1.7.1 Unstable Release
* Improvement: new individual preference tab page for Gen-AI settings.
* Merged bug fixes from v1.6.11
* Update PlantUML to 1.2024.3, langchain4j to 0.27.1 etc.


### V1.6.11 release
* New installer for macOS with Apple Silicon。
* Fix: unable to quit input helper by ESC in code editor when the suggestion list get focused.
### V1.6.11 Release
* New installer for macOS with Apple Silicon.
* Fix: unable to quit input helper by `ESC` in code editor when the suggestion list get focused.


### V1.7.0 Unstable Release
Expand All @@ -17,19 +25,19 @@


### V1.6.10 Release
* Fix: suggestion list in code editor doesn't disappear in some cases.
* Fix: suggestion list in code editor doesn't disappear in some cases.
* Fix: moving caret in wrapped text doesn't work well since the input helper is introduced.


### V1.6.9 Unstable Release
* Improvement: optimized suggestion list of input helper by removing special characters.
* Improvement: optimized suggestion list of input helper by removing special characters.
* Improvement: add separator to suggestion list for words from different plugins.
* Fix: the dialog for creating file link after importing image from file to mind map should be the yes/no buttons mode instead of ok/cancel.
* Fix: exception when save a file as a new file with the same path.
* Fix: missing .jpeg file type support.
* Fix: the dialog for creating file link after importing image from file to mind map should be the yes/no buttons mode instead of ok/cancel.
* Fix: exception when save a file as a new file with the same path.
* Fix: missing .jpeg file type support.
* Fix: exception when copy&paste some specific indent text to a mind map topic.
* Fix: selection handling for root node is incorrect after undo in mind map.
* Fix: relocating suggestion list to inappropriate point if it exceeds parent pane.
* Fix: selection handling for root node is incorrect after undo in mind map.
* Fix: relocating suggestion list to inappropriate point if it exceeds parent pane.
* update JavaFX to 21.0.2, bundled Java to 21.0.2.


Expand All @@ -46,18 +54,18 @@


### V1.6.7 Unstable Release
* Fix: remove build option `jdk.gtk.version` since the JavaFX 21 does no longer support GTK 2.
* Fix: remove build option `jdk.gtk.version` since the JavaFX 21 does no longer support GTK 2.
* Fix: suggestion list of input helper is not in the appropriate position when there are too many items in it.
* Fix: escape from suggestion mode by `ESC` key does not work on Linux.
* Fix: exception when close all tabs with markdown or plantuml file opened but never loaded.
* Fix: exception when close all tabs with markdown or plantuml file opened but never loaded.

### V1.6.6 Unstable Release
* Improvement: better text selection after quick inserting from toolbar or shortcuts in code editor.
* Fix: exception when insert some text from toolbar or shortcuts to the end of file.
* Fix: exception when close all tabs with any markdown or plantuml file opened but never loaded.
* Fix: exception when click on error of status bar when a syntax error exists for plantuml.
* Fix: wrong behavior when quick inserting markdown code quote while no text selection in code editor.
* Fix: limit the input helper suggestions to at least 3 letters.
* Fix: exception when close all tabs with any markdown or plantuml file opened but never loaded.
* Fix: exception when click on error of status bar when a syntax error exists for plantuml.
* Fix: wrong behavior when quick inserting markdown code quote while no text selection in code editor.
* Fix: limit the input helper suggestions to at least 3 letters.


### V1.6.5 Unstable Release
Expand Down Expand Up @@ -88,16 +96,16 @@
* Improvement: add horizontal rule button to markdown toolbar for quick inserting.
* Improvement: use clearable text field for keyword input.
* Improvement: show image resolution in image viewer .
* Improvement: add `Open` menu item to workspace context menu.
* Improvement: add `Open` menu item to workspace context menu.
* Improvement: add context menu for recent files list view.
* Fix: pressing backspace to delete letters, the input helper should not work when only 1 letter left.
* Update javafx to 21 and other dependencies includes plantuml, slf4j etc.
* Fix: pressing backspace to delete letters, the input helper should not work when only 1 letter left.
* Update javafx to 21 and other dependencies includes plantuml, slf4j etc.
* Merged bug fixes from v1.5.6.

### V1.5.6 Release
* Improvement: for mind map, use selected text in input box instead of selected topic as default search keyword.
* Fix: file extension be added to the Markdown doc title, which is not appropriate and makes an unnecessary file link to itself.
* Fix: the new created file name extension is missing if inputted name contains dot(.)
* Fix: the new created file name extension is missing if inputted name contains dot(.)

### V1.6.1 Unstable Release
* Feature: add new preference option to toggle the input helper for code editor.
Expand All @@ -107,7 +115,7 @@
* Fix: underline between words doesn't display in input helper.
* Fix: letters don't display when using system input method.
* Fix: input help doesn't work while caret is not at the end of line.
* Fix: all candidate words displays in some cases.
* Fix: all candidate words displays in some cases.
* Merged bug fixes from v1.5.5

### V1.5.5 Release
Expand All @@ -125,7 +133,7 @@
* Improvement: minor improvement of mind map themes.
* Improvement: optimize the logger performance.
* Fix: the reset default preferences doesn't work for theme options.
* Fix: the "show collapsator on mouse over" option is always disabled.
* Fix: the "show collapsator on mouse over" option is always disabled.
* Fix: the installer is unable to launch on macOS 14 Sonoma.

### V1.5.3 Unstable Release
Expand Down Expand Up @@ -165,8 +173,8 @@
* Fix: dialog is not in center of screen when exporting mind map to image.

### V1.5.0 Unstable Release
* New Feature: add preview and resizing dialog for inserting image to mind map topic from clipboard or disk.
* Improvement: optimized quality of embedded image in mind map topic.
* New Feature: add preview and resizing dialog for inserting image to mind map topic from clipboard or disk.
* Improvement: optimized quality of embedded image in mind map topic.
* Merged bug fixes from v1.4.3.

### V1.4.3 Release
Expand Down Expand Up @@ -198,7 +206,7 @@
* quote block
* code block
* table
* Improvement:
* Improvement:
* add syntax highlight of emphasis text block, list, numbered list, table for Markdown editor.
* improved syntax highlighting for PlantUML editor.

Expand All @@ -214,7 +222,7 @@
* use graphical line breaker instead in result items for code based file type(*.md, *.puml, *.txt).
* use graphical connector in result items for Mind Map topics.
* precisely locating keyword in editor for opening file from search result.
* Fix: exception when search blank keyword in the search result panel
* Fix: exception when search blank keyword in the search result panel.
* update demo workspace.
* Some other refactors.

Expand All @@ -229,13 +237,13 @@
* Improvement: new icons for workspace, folder and all kinds of files.
* Improvement: add more icons to editors and some dialogs.
* Improvement: changed some icons for contexts menu and dialogs.
* Fix: menu items to create folder or files doesn't work in some cases.
* Fix: the relative file link is unable to be located.
* Fix: menu items to create folder or files doesn't work in some cases.
* Fix: the relative file link is unable to be located.
* Fix: paste doesn't work in note editor of mind map.
* update plantuml to 1.2023.8 and other dependencies.

### V1.2.7 Release
* Fix: menu items to create folder or files doesn't work in some cases.
* Fix: menu items to create folder or files doesn't work in some cases.
* Fix: the relative file link is unable to be located in mind map.

### V1.3.1 Unstable Release
Expand Down Expand Up @@ -307,13 +315,13 @@
* Fix: wrong displaying path in context menu from file in workspace.

### V1.1.2 Release
* Fix: rename an opened file and edit the file, the file name in tab will be recovered to the original.
* Fix: rename an opened file and edit the file, the file name in tab will be recovered to the original.
* Fix: exception occasionally when locate file in workspace.
* Fix: exception when exporting mindmap to freemind.
* Fix: exception when popup menu on a renamed file.

### V1.2 Beta
* New Feature: add WYSIWYG CSV file editor.
* New Feature: add WYSIWYG CSV file editor.
* Fix: exception when popup menu on a renamed file.
* Update JavaFX to 20, PlantUML to 1.2023.5 and some other dependencies.

Expand Down Expand Up @@ -381,7 +389,7 @@

### v1.0 RC1
* Improvement: auto scroll code editor to show the caret when it is out of view-port.
* Improvement: take original file name as default export file name for mind map file.
* Improvement: take original file name as default export file name for mind map file.
* Improvement: add sorting toggle button for result list of "go to file".
* Improvement: add status message for zoom in/out mind map, preview content or image file.
* Improvement: use new icon for search bar, "find in files" dialog and result panel.
Expand Down
9 changes: 6 additions & 3 deletions docs/release-notes/v1.7/v1.7.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,13 @@

### New Features

* new experimental support for Gen-AI, you can now generate text content by OpenAI API in mind map, Markdown editor, PlantUML editor.
> you need to setup your OpenAI API key to use it
* new experimental support for Gen-AI, you can now generate text content by API of LLM in mind map, Markdown editor and PlantUML editor.
> you need to setup your API key to use it
Supported LLM model list:
* OpenAI
* Ali Qwen

* proxy support for internet access.
* proxy support for internet access, you can setup HTTP or SOCKS5 proxy to be used for API of Gen-AI provider.


---
Expand Down
Loading

0 comments on commit 0513a2f

Please sign in to comment.