English | 简体中文 | 日本語

MiaoYan

Lightweight Markdown note-taking app for macOS

Features

• Fantastic: Local-first, privacy-focused, syntax highlighting, PPT mode, LaTeX, Mermaid diagrams
• Beautiful: Minimalist design, three-column layout, dark mode, distraction-free
• Fast: Swift 6 native, better performance than Electron-based apps
• Simple: Lightweight, keyboard shortcuts, auto-formatting

Installation & Setup

1. Download the latest DMG package from GitHub Releases (Requires macOS 11.5+)
2. Double-click to install MiaoYan.app to Applications
3. Create a MiaoYan folder in iCloud Drive or your preferred location
4. Open MiaoYan Preferences and set the storage location to this folder
5. Click the "New Folder" icon in the top-left corner to create document categories and start writing

Documentation

• Markdown Syntax Guide - Complete syntax reference with advanced features
• PPT Presentation Mode - Guide to creating presentations with --- slide separators

Support

1. I have two cats named Tangyuan and Cola. If MiaoYan brightens your day, feel free to treat them to some canned food 🥩.
2. If you enjoy MiaoYan, please star the project on GitHub and share it with friends who might love it too.
3. Follow me on Twitter for the latest updates or join the Telegram group to chat with the community.

Acknowledgments

• glushchenko/fsnotes - Initial project structure reference
• stackotter/swift-cmark-gfm - Swift Markdown parser
• simonbs/Prettier - Markdown formatting utilities
• raspu/Highlightr - Syntax highlighting
• TsangerType - TsangerJinKai font (default font)
• hakimel/reveal.js - PPT presentation framework
• Vercel - Static hosting for miaoyan.app
  

License

MIT License - Feel free to use and contribute.