Skip to content

PapaNaya-dev/MarkFlow

Repository files navigation

MarkFlow

MarkFlow is a elegant, minimalist Markdown editor and reader for Windows that features real-time Mermaid diagram visualization and professional PDF export capabilities.

MarkFlow

Features

  • Minimalist Design: Clean, GitHub-inspired interface for focused writing.
  • 📊 Mermaid Diagrams: Visualize flowcharts, sequence diagrams, and more as you type.
  • 📝 Live Preview: Dual-pane layout with high-performance real-time rendering.
  • 📄 PDF Export: Generate professional A4 PDF documents with a single click.
  • 🚀 Built for Windows: Native desktop application performance.
  • 📦 Single Portable EXE: No installation required.

Installation / Usage

You can download the latest version from the Releases page.

  1. Download MarkFlow-Portable.exe.
  2. Double-click to run.

For Developers

If you'd like to build the project yourself:

Prerequisites

Setup

# Clone the repository
git clone https://github.com/PapaNaya-dev/markflow.git

# Install dependencies
npm install

# Build the renderer
npm run build

# Start the application
npm start

Packaging

# Generate the Portable EXE
npm run dist

Credits

Developed by @erichosang

License

This project is licensed under the MIT License.

About

MarkFlow is a elegant, minimalist Markdown editor and reader for Windows that features real-time Mermaid diagram visualization and professional PDF export capabilities.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors