Skip to content

Latest commit

 

History

History
86 lines (62 loc) · 4.79 KB

README_CN.md

File metadata and controls

86 lines (62 loc) · 4.79 KB

MarkFlowy alpha

English | 简体中文

Build Status Downloads MIT License

PRs Welcome Code of Conduct Commit Activity TypeScript-version-icon Rust-version-icon

App Version

⚠️ MarkFlowy 目前处于 Alpha 阶段

目前 MarkFlowy还处于alpha阶段,建议在有数据备份的情况下使用。

Features

  • 内置ChatGpt. 当前支持一键导出对话、翻译文章到任何语言以及获取文章摘要,让ChatGPT成为你的智能助手。
  • 超轻量. MarkFlowy 基于 tauri, 拥有小于 10MB 的体积和更好的性能。
  • 高可用性. MarkFlowy 使用 remirror 作为编辑器核心, 不仅扩展性高,编辑体验也很好。并支持多种编辑模式,如source code, wysiwyg.
  • 自定义主题. MarkFlowy 支持自定义主题,并且你也可以与他人分享你的主题。

下载

支持平台 Linux, macOS 和 Windows.

Note

因为苹果安全策略对于没有开发者认证软件的限制,导致 macOS aarch64 版本无法直接安装. 你可以通过一下步骤忽略该限制:

  • 打开终端
  • 进入到 应用 的目录下. 例如 /Applications.
  • 执行 xattr -cr MarkFlowy.app 然后打开 app 即可
  • 请确保下载来源: github releases.

请看 releases page

为什么

在目前,我使用过很多Markdown应用,但没有遇到非常适合我的,我一直希望可以有一款高效、美观、轻量、数据安全并且可以方便的与各种工作流结合的Markdown编辑器,这也是做 MarkFlowy 的初衷。

参与

目前 MarkFlowy 仍处于初级阶段,可能会有一些不好的体验或bug。欢迎所有感兴趣或遇到使用问题的合作伙伴提交issuePR参与这个项目。

如何贡献

您可以阅读[CONTRIBUTING](./CONTRIBUTING.md)了解如何启动项目和修改代码,欢迎参与代码贡献。

支持

MarkFlowy 是完全永久开源的,如果你想支持 MarkFlowy,你可以star这个项目。这会给我们很大的支持和帮助。

感谢

  • Tauri - 一个用于构建跨平台应用程序的框架,为 MarkFlowy 提供了可靠的基础。
  • React - Web 用户界面框架。
  • Remirror - React 的 ProseMirror 工具包,MarkFlowy 编辑器基于此开发。
  • Rino - package/editor 有部分初始化代码来源于此。
  • Vite - 前端构建工具
  • Xplorer - 主页主题来自 Xplorer.

另外,感谢所有 MarkFlowy 依赖的开源项目。