ContextQMD
Back to Miaoyan

README

README.md

3.5.15.0 KB
Original Source
<h4 align="right">English | <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"></a> <h1 align="center">MiaoYan</h1> <div align="center"> <a href="https://twitter.com/HiTw93" target="_blank"> </a> <a href="https://t.me/+GclQS9ZnxyI2ODQ1" target="_blank"> </a> <a href="https://github.com/tw93/MiaoYan/releases" target="_blank"> </a> <a href="https://github.com/tw93/MiaoYan/commits" target="_blank"> </a> <a href="https://github.com/tw93/MiaoYan/issues?q=is%3Aissue+is%3Aclosed" target="_blank"> </a> </div> <div align="center">Lightweight Markdown note-taking app for macOS</div> </p>

Features

  • Fantastic: Local-first, no data collection, split editor & preview, wikilink backlinks, LaTeX, Mermaid
  • Beautiful: Minimalist design, three-column layout, dark mode, macOS 26 glass, distraction-free
  • Fast: Swift 6 native, better performance than Electron-based apps
  • Simple: Lightweight, version history, keyboard shortcuts, auto-formatting

Installation

  1. Mac App Store (paid, automatic updates):

    <a href="https://apps.apple.com/cn/app/miaoyan/id6759252269"></a>

  2. Homebrew:

    bash
    brew install --cask miaoyan

  3. GitHub Releases: download the latest DMG from GitHub Releases (macOS 11.5+)

All three options share the same codebase and receive the same updates. After installing, create a MiaoYan folder in iCloud Drive or your preferred location, open Preferences (⌘,), and set the storage path.

CLI

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

bash
# 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.

Documentation

Support

  • If MiaoYan helped you, share it with friends or give it a star.
  • Got ideas or bugs? Open an issue or PR, feel free to contribute your best AI model.
  • I have two cats, TangYuan and Coke. If you think MiaoYan delights your life, you can feed them <a href="https://miaoyan.app/cats.html?name=MiaoYan" target="_blank">canned food 🥩</a>.

Acknowledgments

License

MIT License - Feel free to use and contribute.