## MarkFlowy is in the reconstruction phase ⚠️
At present, MarkFlowy needs about 3 - 6 months to perform reconstruction, which will bring an exciting new version. If there is no major bug in the three months, the new version will not be released.
## Features
- **Built-in AI:** Currently supports Copilot, one-click export of dialogues, translation of articles to any language, and article summaries. It supports large models like `DeepSeek` and `Chatgpt`, making them your intelligent assistant.
- **lightweight:** MarkFlowy is based on Tauri, boasting a size of less than 20MB and improved performance.
- **Multiple Editing Modes:** MarkFlowy uses Prosemirror as its core editor, offering high extensibility and a superior editing experience. It supports multiple editing modes, such as source code and wysiwyg.
- **Editing Multiple File Types:** In addition to Markdown, it supports editing `JSON`, `TXT`, and other file types.
- **Custom Themes:** Supports custom themes, and you can share your themes with others.
- **Custom Keyboard Shortcuts:** Supports custom keyboard shortcuts to meet individual needs.
- **Image Processing:** When pasting images into MarkFlowy, you can choose to paste them to a specified path or convert them to `base64`.
- **File Management**: A powerful file tree that supports drag-and-drop movement, global search, and other common functions.
- **Multi-language support:** Supports multiple languages including Chinese, English, Spanish, Japanese, and French.
## Download
Available for Linux, macOS and Windows.
### Linux installer
On Linux, you can download and run `scripts/install-linux.sh` directly:
```sh
curl -fsSL https://raw.githubusercontent.com/drl990114/MarkFlowy/main/scripts/install-linux.sh -o install-linux.sh
sh install-linux.sh
```
If `curl` is unavailable, use `wget` instead:
```sh
wget -O install-linux.sh https://raw.githubusercontent.com/drl990114/MarkFlowy/main/scripts/install-linux.sh
sh install-linux.sh
```
The script downloads the AppImage for your architecture, installs it to `~/.local/share/markflowy`, and creates the `~/.local/bin/markflowy` command. To uninstall:
```sh
sh install-linux.sh --uninstall
```
> [!NOTE]
> Because of Apple’s security policy restrictions on software without developer certification, the **macOS aarch64** version cannot be downloaded and used directly. You can ignore the limit by doing the following:
> - Open your terminal
> - Go to the `Applications` directory. .e.g `/Applications`.
> - Run `xattr -cr MarkFlowy.app` and open the app again
> - Please make sure you download from `github releases`.
You can download it from [GitHub Releases](https://github.com/drl990114/MarkFlowy/releases).
## Why
**Actually, the initial inspiration for MarkFlowy stemmed from a casual conversation with a friend a few years ago**. As developers, we shared many expectations for an ideal Markdown editor. After trying many existing applications, I felt they couldn't fully meet our comprehensive needs in terms of efficiency, aesthetics, lightweight design, and workflow integration. We envisioned our ideal editor together. Although we later went our separate ways and lost touch, that seed of desire to create something beautiful has always remained in my heart.
It was this initial aspiration that propelled me step by step to transform MarkFlowy from a concept into reality. I hope to create a lightweight, intelligent editor that not only handles content securely and reliably but also improves editing efficiency through AI.
MarkFlowy is a product, and also a testament to a life journey. Through continuous learning and development, it has grown into my response to the concepts of **efficiency, intelligence, and lightweight**. I hope MarkFlowy will become a tool that everyone finds convenient and enjoyable, and I welcome everyone to experience it and provide valuable feedback.
## Contribute
The current MarkFlowy is still in its infancy, and there may be some bad experiences or bugs, for which I am sorry. All partners who are interested or encounter usage problems are welcome to submit [issues](https://github.com/drl990114/MarkFlowy/issues/new) or [PR](https://github.com/drl990114/MarkFlowy/compare) to participate in this project.
### How to Contribute
You can read [CONTRIBUTING](./docs/en/Community/CONTRIBUTING.md) to know how to start the project and modify the code, Welcome to participate in code contribution.
## Support
MarkFlowy is completely and permanently open source, if you want to support MarkFlowy, you can `star` this project. For special support, please contact me via [email](mailto:drl990114@gmail.com).
## Special Thanks
- [rino](https://github.com/ocavue/rino) by [ocavue](https://github.com/ocavue) - The initial version of the editor in this project was developed based on rino.
- [remirror](https://remirror.io/) - A powerful ProseMirror-based rich text editor framework.
- [tauri](https://tauri.app/) - Build smaller, faster, and more secure desktop apps with a web frontend.
- And thanks to all the open source libraries and projects that MarkFlowy depends on.
## Contributors
The development of **MarkFlowy** cannot be separated from these contributors. They have contributed a lot of abilities to **MarkFlowy**. Meanwhile, welcome to follow them! ❤️
Drl990114 |
Qiu Shao |
Lysastriel |
Qiaochu Hu |
Null |
Husam Alshehadat |
Mariano Esteban |
Null |
Alexander |
Chiefass |
Dai |
Fossabot |
Null |
Pun Kyard |