MiaoYan

<h4 align="right">English | <strong><a href="https://github.com/tw93/MiaoYan/blob/main/README_ES.md">Español</a></strong> | <strong><a href="https://github.com/tw93/MiaoYan/blob/main/README_CN.md">简体中文</a></strong></h4> <p align="center"> <a href="https://miaoyan.app/" target="_blank"><img src="https://gw.alipayobjects.com/zos/k/t0/43.png" width="138" /></a> <h1 align="center">MiaoYan</h1> <div align="center"> <a href="https://twitter.com/HiTw93" target="_blank"> <img alt="Twitter Follow" src="https://img.shields.io/badge/follow-Tw93-red?style=flat-square&logo=Twitter"></a> <a href="https://t.me/+GclQS9ZnxyI2ODQ1" target="_blank"> <img alt="Telegram" src="https://img.shields.io/badge/chat-Telegram-blueviolet?style=flat-square&logo=Telegram"></a> <a href="https://github.com/tw93/MiaoYan/releases" target="_blank"> <img alt="GitHub Downloads" src="https://img.shields.io/github/downloads/tw93/MiaoYan/total.svg?style=flat-square"></a> <a href="https://github.com/tw93/MiaoYan/commits" target="_blank"> <img alt="GitHub Commit Activity" src="https://img.shields.io/github/commit-activity/m/tw93/MiaoYan?style=flat-square"></a> <a href="https://github.com/tw93/MiaoYan/issues?q=is%3Aissue+is%3Aclosed" target="_blank"> <img alt="GitHub Closed Issues" src="https://img.shields.io/github/issues-closed/tw93/MiaoYan.svg?style=flat-square"></a> <img alt="macOS 11.5+" src="https://img.shields.io/badge/macOS-11.5%2B-orange?style=flat-square"> </div> <div align="center">Lightweight Markdown note-taking app for macOS</div> </p> <img src="https://raw.githubusercontent.com/tw93/static/main/miaoyan/miaoyan.gif" width="900px" />

Features

• Fantastic: Local-first, no data collection, split editor & preview, LaTeX, Mermaid
• 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 from the Mac App Store. Future updates will be continuously published there, warmly welcome! If you'd like to support me, a paid download on the App Store is a great way to do so. The open-source version offers the same experience.

   <a href="https://apps.apple.com/cn/app/miaoyan/id6759252269"><img src="https://cdn.tw93.fun/uPic/C3Renh.png" width="160" alt="Download on the Mac App Store" /></a>

2. Or install by Homebrew:

brew install --cask miaoyan

3. Or install manually: download the latest DMG package from GitHub Releases (Requires macOS 11.5+)
4. Open DMG and drag MiaoYan.app to Applications
5. First Launch: Double-click MiaoYan.app to launch directly — the app is now notarized by Apple ✓
6. Create a MiaoYan folder in iCloud Drive or your preferred location
7. Open MiaoYan Preferences and set the storage location to this folder
8. Click the "New Folder" icon in the top-left corner to create document categories and start writing

After installation, we recommend exploring Preferences (⌘,) to discover MiaoYan's rich customization options, including edit modes, themes, fonts, and more to create your perfect writing environment.

CLI

MiaoYan provides a command-line interface for quick note operations.

# Install
curl -fsSL https://raw.githubusercontent.com/tw93/MiaoYan/main/scripts/install.sh | bash

# Usage
miao open <title|path>    # Open note
miao new <title> [text]   # Create new note
miao search <query>       # Search notes in terminal
miao list [folder]        # List top-level folders, or markdown in folder
miao cat <title|path>     # Print note content
miao update               # Update CLI

Split Editor & Preview Mode

Edit and preview side by side with real-time preview and 60fps bidirectional scroll sync.

Quick Toggle: Press ⌘\ to instantly toggle split view mode, or enable it in Preferences → Interface → Edit Mode → Split Mode.

Why not WYSIWYG like Typora? We prioritize pure Markdown editing experience, and implementing WYSIWYG in native Swift is overly complex with reliability concerns. Split mode maintains clean editing while providing instant visual feedback.

<img src="https://gw.alipayobjects.com/zos/k/eg/jV8Gra.png" width="100%" alt="Split Editor & Preview Mode" />

Documentation

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

Support

<a href="https://miaoyan.app/cats.html"><img src="https://rawcdn.githack.com/tw93/MiaoYan/vercel/assets/sponsors.svg" width="1000px" /></a>

1. Cats: Tangyuan & Cola — if MiaoYan helps, <a href="https://miaoyan.app/cats.html" target="_blank">treat them to canned food 🥩</a>.
2. If you enjoy MiaoYan, please consider giving it a star and recommending it to your friends.
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
  <a href="https://vercel.com?utm_source=tw93&utm_campaign=oss"> <img src="https://gw.alipayobjects.com/zos/k/wr/powered-by-vercel.svg" width="136" alt="Powered by Vercel" /> </a>

License

MIT License - Feel free to use and contribute.