<div align="center"> <img align="center" src="./public/logo.png" width="120" height="120" /> </div> <h2 align="center"/>MarkFlowy ^{<em>beta</em>}</h2> <div align='center'> <br> <em>Modern and intelligent Markdown editor.</em> <br> <br> </div> <div align="center"> [](https://github.com/drl990114/MarkFlowy) [](https://atomgit.com/drl990114/MarkFlowy) [![App Version][version-badge]][release] [![Downloads][downloads-badge]][release] <br/> [![Build Status][build-badge]][build] [![Code of Conduct][coc-badge]][coc] [![Commit Activity][commit-badge]][commit] [![issues-closed]](https://github.com/drl990114/MarkFlowy/issues?q=sort%3Aupdated-desc+is%3Aissue+is%3Aclosed) <br/> [![PRs Welcome][prs-welcome-badge]][prs-welcome] [![TypeScript-version-icon]](https://www.typescriptlang.org/) [![Rust-version-icon]](https://www.rust-lang.org/) [![License][license-badge]][license] [![codefactor]](https://www.codefactor.io/repository/github/drl990114/markflowy) <br/> </div> <h4 align="center"><strong>English</strong> | <a href="./README_CN.md">简体中文</a> | <a href="./README_JA.md">日本語</a></h4> <img src="./public/show-en.png" alt="screenshot" /> ## MarkFlowy is in Beta Stage ⚠️ Currently, MarkFlowy is in the beta stage, and it is recommended to use it with data backups. ## 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. > [!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` or [UpgradeLink](https://download.upgrade.toolsetlink.com/download?appKey=xpn68m4j5qU0Y1rfDYFHaA). You can download it from the [UpgradeLink download page](https://download.upgrade.toolsetlink.com/download?appKey=xpn68m4j5qU0Y1rfDYFHaA) or [GitHub Release](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). <!-- In addition, you can sponsor me through WeChat or Alipay, which will greatly encourage me. And it will also be used for the subsequent development of the project, such as expenses for servers, domains, etc [Sponsor](https://drl990114.github.io/sponsor) | WeChat appreciates | Alipay appreciates | | :-: | :-: | | <img src="https://drl990114.github.io/images/wxpay.png" alt="WeChat QRcode" width=200> <br><small>Let's have a bottle of wine~</small> | <img src="https://drl990114.github.io/images/alipay.png" alt="Wechat QRcode" width=200> <br><small>Have a cup of coffee~</small> | --> ## Sponsors <a href="https://www.toolsetlink.com"> <img height="54" alt="UpgradeLink" src="./public/sponsors/UpgradeLink_1.png" /> </a> ## 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! ❤️ <!-- readme: contributors -start --> <table> <tr> <td align="center"> <a href="https://github.com/drl990114"> <img src="https://avatars.githubusercontent.com/u/48054715?v=4" width="90;" alt="drl990114"/> <br /> _{<b>Drl990114</b>} </a> </td> <td align="center"> <a href="https://github.com/codeErrorSleep"> <img src="https://avatars.githubusercontent.com/u/20470033?v=4" width="90;" alt="codeErrorSleep"/> <br /> _{<b>Qiu Shao</b>} </a> </td> <td align="center"> <a href="https://github.com/AdySnowflake"> <img src="https://avatars.githubusercontent.com/u/163967164?v=4" width="90;" alt="AdySnowflake"/> <br /> _<b>Null</b> </a> </td> <td align="center"> <a href="https://github.com/SamDc73"> <img src="https://avatars.githubusercontent.com/u/144215270?v=4" width="90;" alt="SamDc73"/> <br /> _{<b>Husam Alshehadat</b>} </a> </td> <td align="center"> <a href="https://github.com/KiraKiraAyu"> <img src="https://avatars.githubusercontent.com/u/99468824?v=4" width="90;" alt="KiraKiraAyu"/> <br /> _{<b>Lysastriel</b>} </a> </td> <td align="center"> <a href="https://github.com/marianoesteban"> <img src="https://avatars.githubusercontent.com/u/3076449?v=4" width="90;" alt="marianoesteban"/> <br /> _{<b>Mariano Esteban</b>} </a> </td> <td align="center"> <a href="https://github.com/Raven-1027"> <img src="https://avatars.githubusercontent.com/u/83693755?v=4" width="90;" alt="Raven-1027"/> <br /> _<b>Null</b> </a> </td></tr> <tr> <td align="center"> <a href="https://github.com/chiefass"> <img src="https://avatars.githubusercontent.com/u/106591791?v=4" width="90;" alt="chiefass"/> <br /> _{<b>Chiefass</b>} </a> </td> <td align="center"> <a href="https://github.com/dai"> <img src="https://avatars.githubusercontent.com/u/12391?v=4" width="90;" alt="dai"/> <br /> _<b>Dai</b> </a> </td> <td align="center"> <a href="https://github.com/fossabot"> <img src="https://avatars.githubusercontent.com/u/29791463?v=4" width="90;" alt="fossabot"/> <br /> _{<b>Fossabot</b>} </a> </td> <td align="center"> <a href="https://github.com/hope-zjl"> <img src="https://avatars.githubusercontent.com/u/54581644?v=4" width="90;" alt="hope-zjl"/> <br /> _<b>Null</b> </a> </td> <td align="center"> <a href="https://github.com/punkyard"> <img src="https://avatars.githubusercontent.com/u/59349105?v=4" width="90;" alt="punkyard"/> <br /> _{<b>Pun Kyard</b>} </a> </td></tr> </table> <!-- readme: contributors -end --> <!-- badges --> [build-badge]: https://img.shields.io/github/actions/workflow/status/drl990114/MarkFlowy/nodejs.yml.svg?style=flat-square&labelColor=black [build]: https://github.com/drl990114/MarkFlowy/actions/workflows/nodejs.yml?labelColor=black [downloads-badge]: https://img.shields.io/github/downloads/drl990114/MarkFlowy/total?label=downloads&style=flat-square&labelColor=black [license-badge]: https://img.shields.io/badge/license-AGPL-purple.svg?style=flat-square&labelColor=black [license]: https://opensource.org/licenses/AGPL-3.0?labelColor=black [release]: https://github.com/drl990114/MarkFlowy/releases?labelColor=black [prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square&labelColor=black&color=%23dd5c13 [prs-welcome]: https://github.com/drl990114/MarkFlowy/blob/main/CONTRIBUTING.md?labelColor=black [coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square&labelColor=black [coc]: https://github.com/drl990114/MarkFlowy/blob/main/CODE_OF_CONDUCT.md?labelColor=black [commit-badge]: https://img.shields.io/github/commit-activity/m/drl990114/MarkFlowy?color=%23ff9900&style=flat-square&labelColor=black [commit]: https://github.com/drl990114/MarkFlowy?labelColor=black [version-badge]: https://img.shields.io/github/v/release/drl990114/MarkFlowy?color=%239accfe&label=version&style=flat-square&labelColor=black [rust-version-icon]: https://img.shields.io/badge/Rust-1.85.0-dea584?style=flat-square&labelColor=black [typescript-version-icon]: https://img.shields.io/github/package-json/dependency-version/drl990114/MarkFlowy/dev/typescript?label=TypeScript&style=flat-square&labelColor=black [issues-closed]: https://img.shields.io/github/issues-closed/drl990114/MarkFlowy.svg?style=flat-square&labelColor=black [codefactor]: https://www.codefactor.io/repository/github/drl990114/markflowy/badge/main?style=flat-square&labelColor=black ## License [](https://app.fossa.com/projects/git%2Bgithub.com%2Fdrl990114%2FMarkFlowy?ref=badge_large)