MCPcopy Index your code
hub / github.com/drl990114/MarkFlowy

github.com/drl990114/MarkFlowy @v0.82.1

Chat with this repo
repository ↗ · DeepWiki ↗ · release v0.82.1 ↗ · + Follow
2,726 symbols 6,844 edges 761 files 82 documented · 3%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

MarkFlowy beta

${en:'Modern and intelligent Markdown editor.', zh:'现代化与智能化的 Markdown 编辑器。', ja:'Modern and intelligent Markdown editor.'}

GitHub Repo stars G-Star [![App Version][version-badge]][release] [![Downloads][downloads-badge]][release]

[![Build Status][build-badge]][build] [![Code of Conduct][coc-badge]][coc] [![Commit Activity][commit-badge]][commit] ![issues-closed]

[![PRs Welcome][prs-welcome-badge]][prs-welcome] ![TypeScript-version-icon] ![Rust-version-icon] [![License][license-badge]][license] ![codefactor]

English | 简体中文 | 日本語

English | 简体中文 | 日本語

English | 简体中文 | 日本語

screenshot

${en:'MarkFlowy is in the reconstruction phase ⚠️', zh:'MarkFlowy 目前处于 Beta 阶段 ⚠️', ja:'MarkFlowy はベータ版です ⚠️'}

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. 目前 MarkFlowy 处于 beta 阶段,建议在有数据备份的情况下使用。 現在、MarkFlowy はベータ版であり、データのバックアップを取ることをお勧めします。

${en:'Features', zh:'功能特性', ja:'機能'}

  • 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.

  • 内置 AI:当前支持Copilot、一键导出对话、翻译文章到任何语言以及获取文章摘要,支持DeepSeekChatgpt等大模型让他们成为你的智能助手。
  • 超轻量:MarkFlowy 基于 tauri, 拥有小于 20MB 的体积和更好的性能。
  • 多编辑模式:MarkFlowy 使用 prosemirror 作为编辑器核心, 不仅扩展性高,编辑体验也很好。并支持多种编辑模式,如source code, wysiwyg
  • 编辑多种文件:除了 Markdown,还支持编辑 jsontxt 等文件类型。
  • 自定义主题:支持自定义主题,并且你也可以与他人分享你的主题。
  • 自定义快捷键:支持自定义快捷键,满足个性化需求。
  • 图片处理:当你粘贴图片到 MarkFlowy,可以选择粘贴到指定的路径,或者转为 base64
  • 文件管理:功能强大的文件树,支持拖拽移动、全局搜索等常用功能。
  • 多语言支持:支持中文、英文、西班牙语、日语、法语等多种语言。
  • AI搭載: 現在はCopilot、ワンタッチで会話をエクスポートし、文章を任意の言語に翻訳し、記事の要約を取得することをサポートしており、「DeepSeek `」、「Chatgpt」などの大きなモデルをサポートして、彼らをスマートアシスタントにしています。

  • 軽量: MarkFlowyはTauriをベースにしており、20MB未満のサイズと優れたパフォーマンスを誇ります。

  • 複数の編集モード: MarkFlowyはProsemirrorをコアエディターとして採用し、高い拡張性と優れた編集エクスペリエンスを提供します。ソースコードやWYSIWYGなど、複数の編集モードをサポートしています。

  • 複数ファイル形式の編集: Markdownに加えて、JSONTXTなどのファイル形式の編集もサポートしています。

  • カスタムテーマ: カスタムテーマをサポートし、作成したテーマを他のユーザーと共有できます。

  • カスタムキーボードショートカット: 個々のニーズに合わせてカスタムキーボードショートカットを設定できます。

  • 画像処理: MarkFlowyに画像を貼り付ける際、指定したパスに貼り付けるか、base64に変換するかを選択できます。

  • ファイル管理: ドラッグアンドドロップによる移動、グローバル検索、その他の一般的な機能をサポートする強力なファイルツリー。

  • 多言語サポート: 中国語、英語、スペイン語、日本語、フランス語を含む複数の言語をサポートします。

${en:'Download', zh:'下载', ja:'ダウンロード'}

Available for Linux, macOS and Windows. 支持平台 Linux, macOS 和 Windows. Linux、macOS、Windows向けに利用可能です。

${en:'Linux installer', zh:'Linux 安装脚本', ja:'Linux インストールスクリプト'}

${en:'On Linux, you can download and run scripts/install-linux.sh directly:', zh:'在 Linux 上,你可以直接下载并运行 scripts/install-linux.sh:', ja:'Linux では、scripts/install-linux.sh を直接ダウンロードして実行できます。'}

curl -fsSL https://raw.githubusercontent.com/drl990114/MarkFlowy/main/scripts/install-linux.sh -o install-linux.sh
sh install-linux.sh

${en:'If curl is unavailable, use wget instead:', zh:'如果没有 curl,可以改用 wget:', ja:'curl が利用できない場合は、代わりに wget を使用します。'}

wget -O install-linux.sh https://raw.githubusercontent.com/drl990114/MarkFlowy/main/scripts/install-linux.sh
sh install-linux.sh

${en:'The script downloads the AppImage for your architecture, installs it to ~/.local/share/markflowy, and creates the ~/.local/bin/markflowy command. To uninstall:', zh:'脚本会下载适配当前架构的 AppImage,安装到 ~/.local/share/markflowy,并创建 ~/.local/bin/markflowy 命令。卸载可执行:', ja:'このスクリプトは現在のアーキテクチャに対応する AppImage をダウンロードし、~/.local/share/markflowy にインストールして、~/.local/bin/markflowy コマンドを作成します。アンインストールするには:'}

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 or UpgradeLink. 因为苹果安全策略对于没有开发者认证软件的限制,导致 macOS aarch64 版本无法直接安装. 你可以通过一下步骤忽略该限制: - 打开终端 - 进入到 应用 的目录下. 例如 /Applications. - 执行 xattr -cr MarkFlowy.app 然后打开 app 即可 - 请确保下载来源: github releasesUpgradeLink. Appleのセキュリティポリシーにより、開発者認証のないソフトウェアはmacOS aarch64版を直接ダウンロードして使用できません。以下の手順で制限を回避できます。 - terminal を開く - Applications ディレクトリに移動します。例: /Applications。 - xattr -cr MarkFlowy.app を実行し、再度アプリを開きます。 - github releases または UpgradeLink からダウンロードしてください。

You can download it from the UpgradeLink download page or GitHub Release 你可以通过 UpgradeLink 下载页面GitHub Release 下载. UpgradeLink ダウンロードページ または GitHub Release からダウンロードできます。

${en:'Why', zh:'为什么开发', ja:'動機'}

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. 其实,创作 MarkFlowy 的最初灵感,源于几年前和一位朋友一次闲聊,作为开发者,我们对一款理想 Markdown 编辑器有很多的期待。在尝试过许多现有应用后,我感到它们难以完全满足在高效、美观、轻量与工作流融合上的综合需求。我们共同畅想了一款理想中编辑器的模样。尽管后来我们各自奔赴不同的人生,联系渐少,但那颗渴望创造美好的种子,一直在我心里。 実は、MarkFlowyの最初のインスピレーションは、数年前の友人との何気ない会話から生まれました。開発者として、私たちは理想的なMarkdownエディタに多くの期待を抱いていました。既存のアプリケーションを数多く試した結果、効率性、美しさ、軽量設計、ワークフロー統合といった点で、私たちの包括的なニーズを完全に満たすことができないと感じました。そこで、私たちは一緒に理想のエディタを思い描きました。その後、別々の道を歩み、連絡も途絶えてしまいましたが、美しいものを作りたいという思いは、常に私の心の中にありました。

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 从构想变为现实。我希望能打造一款轻量、智能的编辑器,让它不仅能安全可靠地处理内容,还能通过 AI 来提高编辑工作的效率。 この最初の思いが、MarkFlowyを構想から現実へと一歩一歩変えていく原動力となりました。コンテンツを安全かつ確実に処理するだけでなく、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. MarkFlowy 是一个产品,也是一段人生旅程的见证。并在一路的学习与构建中,成长为我对高效、智能、轻量这些理念的回应,希望 MarkFlowy 能成为一个让大家感到趁手和愉悦的工具,也欢迎大家能来体验,并提出宝贵的意见。 MarkFlowyは製品であると同時に、私の人生の証でもあります。継続的な学習と開発を通して、効率性、インテリジェンス、軽量性というコンセプトに対する私の答えへと成長しました。 MarkFlowy が皆様にとって便利で楽しいツールになることを願っています。皆様に MarkFlowy を体験していただき、貴重なフィードバックを提供していただければ幸いです。

${en:'Contribute', zh:'参与', ja:'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 or PR to participate in this project. 目前 MarkFlowy 仍处于初级阶段,可能会有一些不好的体验或bug。欢迎所有感兴趣或遇到使用问题的合作伙伴提交issuePR参与这个项目。 現在のMarkFlowyはまだ発展途上であり、悪い体験やバグがあるかもしれません。その点についてはお詫び申し上げます。興味のあるパートナーや使用上の問題に直面している方は、issuesPRを提出して、このプロジェクトに参加してください。

${en:'How to Contribute', zh:'如何贡献', ja:'How to Contribute'}

You can read CONTRIBUTING to know how to start the project and modify the code, Welcome to participate in code contribution. 您可以阅读 CONTRIBUTING 来了解如何启动项目和修改代码,欢迎参与代码贡献。 プロジェクトの開始方法やコードの修正方法については CONTRIBUTING をご覧ください。コードへの貢献を歓迎します。

${en:'Support', zh:'支持', ja:'サポート'}

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. MarkFlowy 是完全永久开源的,如果你想支持 MarkFlowy,你可以star这个项目。特殊赞助可以通过 邮箱 联系我。

MarkFlowyは完全にオープンソースであり、MarkFlowyをサポートしたい場合は、このプロジェクトにstarを付けることができます。特別なサポートが必要な場合は、emailで私に連絡してください。

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

WeChat appreciates Alipay appreciates
WeChat QRcode

Let's have a bottle of wine~ | Wechat QRcode

Have a cup of coffee~ | -->

另外你还可以通过微信或支付宝对我进行赞助,这会给我极大地鼓励。并且也会用于项目后续的发展,如服务器、域名等支出。

赞助列表

微信赞助 支付宝赞助
WeChat QRcode

来瓶酒~ | Wechat QRcode

来杯咖啡~ | -->

Sponsor

WeChat appreciates Alipay appreciates
WeChat QRcode

Let's have a bottle of wine~ | <img

Extension points exported contracts — how you extend this code

Task (Interface)
(no doc) [12 implementers]
apps/desktop/src-tauri/src/task_system/task.rs
LivePreviewNodeViewApi (Interface)
(no doc) [1 implementers]
packages/editor/src/editor/extensions/LivePreviewBlock/live-preview-types.ts
GitHubConfig (Interface)
(no doc)
packages/types/index.ts
BaseComponentProps (Interface)
(no doc)
packages/zens/src/types/global.d.ts
GitHubTreeItem (Interface)
(no doc)
packages/github-api/src/types.ts
ApiResponse (Interface)
(no doc)
packages/api-client/src/index.ts
DefaultTheme (Interface)
(no doc)
packages/interface/src/types/styled-components.d.ts
EventListenerOptions (Interface)
(no doc)
apps/web/global.d.ts

Core symbols most depended-on inside this repo

map
called by 256
packages/editor/src/editor/steps/replace-doc-step.ts
push
called by 251
packages/editor/src/editor/transform/parser.ts
clone
called by 103
apps/desktop/src-tauri/src/task_system/system.rs
dispatch
called by 88
apps/desktop/src-tauri/src/task_system/system.rs
send
called by 73
apps/desktop/src-tauri/src/task_system/task.rs
get
called by 71
apps/desktop/src-tauri/src/app/file_watcher.rs
find
called by 70
packages/interface/src/components/FileTree/types.ts
create
called by 62
packages/interface/src/components/FileTree/types.ts

Shape

Function 1,356
Method 710
Interface 358
Class 250
Enum 52

Languages

TypeScript80%
Rust20%

Modules by API surface

apps/desktop/src-tauri/src/fc.rs71 symbols
apps/desktop/src-tauri/src/task_system/task.rs61 symbols
apps/desktop/src-tauri/src/lib.rs53 symbols
packages/editor/src/editor/extensions/Inline/inline-mark-extensions.ts52 symbols
apps/desktop/src-tauri/src/task_system/worker/runner.rs45 symbols
packages/editor/src/editor/codemirror/codemirror.ts37 symbols
apps/desktop/src/components/EditorArea/TextEditor.tsx36 symbols
packages/editor/src/editor/extensions/Table/table-extension.ts33 symbols
packages/editor/src/editor/transform/parser.ts32 symbols
apps/desktop/src-tauri/src/app/conf.rs29 symbols
apps/desktop/src/stores/useEditorStore.ts28 symbols
packages/editor/src/editor/extensions/TypewriterScroll/typewriter-scroll-extension.ts27 symbols

For agents

$ claude mcp add MarkFlowy \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact