drl990114/MarkFlowy
A high-performance, cross-platform editor that supports WYSIWYG Markdown and general text editing.
MarkFlowy – A Local‑First Markdown Editor with Optional AI Assistants
What it is MarkFlowy is a cross‑platform desktop application (macOS, Windows, Linux) for creating and managing Markdown documents. It lets you work entirely offline, keeping your files in the folders you choose, while also offering an optional AI‑powered “Copilot” that can chat, summarize, translate, or generate text via configurable providers such as OpenAI‑compatible services, DeepSeek, Google, or a local Ollama server.
Core capabilities
- Three editing modes – visual (WYSIWYG), raw Markdown source, and read‑only preview. Switch on the fly.
- Performance‑focused – lazy loading and fast rendering make large files feel snappy.
- Workspace‑oriented file management – open single files or an entire folder, see a file tree, use tabs, split panes, bookmarks, outline view, Quick Open (⌘/Ctrl + P) and workspace search.
- Local history & drafts – automatic snapshots let you compare revisions, recover unsaved work, and coexist with external edits.
- Customization – light/dark themes, a visual theme editor, shortcut mapping, typography tweaks, and automatic or forced text direction (LTR/RTL).
- AI integration – a separate chat window and a “Copilot” mode that can be hooked to any OpenAI‑compatible endpoint or a locally‑run Ollama model. The AI only receives the text you send; no mandatory cloud account.
- Export options – HTML, image screenshots, PDF printing, and (via Pandoc) DOCX, ODT, EPUB. A CLI also supports automated batch exports.
Technology stack
- Frontend – built with TypeScript and the remirror rich‑text framework (a ProseMirror wrapper).
- Desktop shell – Tauri, which bundles a web UI with a lightweight Rust runtime for native windows.
- AI connectivity – plain HTTP calls to configurable endpoints; local inference works with an Ollama server and a downloaded model.
- Packaging – native installers for Windows (EXE/MSI/portable zip), macOS DMG (Intel & Apple‑silicon), and Linux packages (Flatpak, .deb/.rpm via script, AppImage).
Who might use it
- Writers, developers, or researchers who prefer Markdown but want a polished visual editor.
- Users who keep their notes in personal folders and need fast, offline access.
- Anyone who wants optional AI assistance (e.g., drafting, summarising, translating) without committing to a cloud service.
- Teams that value local history and the ability to recover drafts after crashes.
Getting started
- Download the appropriate installer from the latest release page.
- Open a Markdown file or a folder to create a workspace.
- Choose an editing mode from the More menu; use ⌘/Ctrl + P for Quick Open.
- (Optional) Open Settings → AI and configure an endpoint (OpenAI, DeepSeek, Google, Ollama, etc.) to enable Chat or Copilot.
- Explore the built‑in help (
docs/en/intro.md) for shortcuts, export workflows, and workspace tips.
License
The source code is released under the AGPL‑3.0 license. Binary packages may include additional third‑party licenses; the core runtime used for building the app is marked UNLICENSED and is not part of the public repo.
Community & contribution
Issues and pull requests are welcomed. A contributing guide and code‑of‑conduct are provided in the docs/en/Community folder. The project lists a number of contributors and thanks several open‑source libraries (remirror, Tauri, etc.) that it builds upon.
Related
- Project
- Project
- Project
- Project
- Project