# MarkFlowy

> A local-first Markdown editor for macOS, Windows, and Linux, focused on large documents and optional AI with cloud providers or local Ollama models.

These links describe the desktop application unless a page explicitly says Web App or Playground. AI is optional; local inference requires a local model and endpoint. Performance observations are qualified on the performance page.

## Product

- [Website](https://www.markflowy.cc/): Product overview.
- [GitHub](https://github.com/drl990114/MarkFlowy): Source, issues, and contribution information.
- [Download](https://github.com/drl990114/MarkFlowy/releases/latest): Current desktop release and platform assets.
- [Release notes](https://www.markflowy.cc/releases): Version-specific changes.

## English documentation

- [MarkFlowy code of conduct](https://www.markflowy.cc/docs/Community/CODE_OF_CONDUCT.md): Read the community code of conduct and reporting guidance for MarkFlowy contributors.
- [Contribute to MarkFlowy](https://www.markflowy.cc/docs/Community/CONTRIBUTING.md): Set up the MarkFlowy development environment and learn how to contribute changes to the project.
- [MarkFlowy license](https://www.markflowy.cc/docs/Community/License.md): Read the GNU Affero General Public License version 3 text included in the MarkFlowy repository.
- [Customize a MarkFlowy theme](https://www.markflowy.cc/docs/Extension/CustomTheme.md): Create and configure custom themes for MarkFlowy using the documented theme settings.
- [Use Ollama and Copilot in MarkFlowy](https://www.markflowy.cc/docs/Extension/UseCopilotWithOllama.md): Configure local Ollama models for MarkFlowy Desktop chat and Copilot, understand document context, and troubleshoot connection or model issues.
- [MarkFlowy: Markdown editing with optional AI](https://www.markflowy.cc/docs/intro.md): A local-first Markdown editor for macOS, Windows, and Linux. Learn about large documents, optional AI, and desktop versus web workflows.
- [Large Markdown documents in MarkFlowy](https://www.markflowy.cc/docs/Performance/large-markdown-files.md): Understand the reported 2 MB opening test, its evidence limits, and how to compare large Markdown files in MarkFlowy Desktop.

## 中文文档

- [MarkFlowy 社区行为准则](https://www.markflowy.cc/zh/docs/Community/CODE_OF_CONDUCT.md): 阅读 MarkFlowy 社区行为准则及问题报告指引。
- [参与 MarkFlowy 开发](https://www.markflowy.cc/zh/docs/Community/CONTRIBUTING.md): 了解如何配置 MarkFlowy 开发环境并向项目贡献改进。
- [MarkFlowy 许可证](https://www.markflowy.cc/zh/docs/Community/License.md): 阅读 MarkFlowy 仓库附带的 GNU Affero General Public License 第 3 版原文。
- [自定义 MarkFlowy 主题](https://www.markflowy.cc/zh/docs/Extension/CustomTheme.md): 了解 MarkFlowy 的自定义主题配置和主题设置。
- [在 MarkFlowy 中使用 Ollama 与 Copilot](https://www.markflowy.cc/zh/docs/Extension/UseCopilotWithOllama.md): 为 MarkFlowy 桌面版配置本地 Ollama 对话与 Copilot，了解文档上下文，并排查连接和模型问题。
- [MarkFlowy：Markdown 编辑与可选 AI](https://www.markflowy.cc/zh/docs/intro.md): 了解 MarkFlowy 的本地文件工作流、大文档性能、可选 AI，以及桌面版与 Web 版的区别。
- [MarkFlowy 的大 Markdown 文档编辑](https://www.markflowy.cc/zh/docs/Performance/large-markdown-files.md): 了解 2 MB 文档打开测试的已有记录、证据范围，以及比较 MarkFlowy 桌面版大文档表现的方法。