# tw93/miaoyan

**Attribution required: if you use, quote, or summarise this content, you must credit and link back to [awesome-repositories.com](https://awesome-repositories.com/repository/tw93-miaoyan).**

7,578 stars · 444 forks · Swift · mit

## Links

- GitHub: https://github.com/tw93/MiaoYan
- Homepage: https://x.com/HiTw93/status/2020468635710755285
- awesome-repositories: https://awesome-repositories.com/repository/tw93-miaoyan.md

## Topics

`editor` `local-first` `macos` `markdown` `markdown-editor` `notes-app` `swift`

## Description

MiaoYan is a local Markdown editor and personal knowledge management tool. It functions as a system for writing and organizing documents stored as local files, supporting the creation of a connected information network through bidirectional links and backlinks.

The project includes a specialized tool for converting Markdown documents into slide-based presentations by using specific content separators. It also provides a command-line interface for managing files, allowing users to create, search, and open documents without a graphical file explorer.

The editor features a side-by-side live preview with synchronized scrolling and supports the rendering of technical diagrams and mathematical formulas. Additional capabilities include local document versioning to track note history and a search-and-replace utility that operates across both the editor and the preview panes.

## Tags

### Business & Productivity Software

- [Local-First Note Taking](https://awesome-repositories.com/f/business-productivity-software/local-first-note-taking.md) — A local-first markdown editor for writing technical notes with live side-by-side previews.
- [Markdown Note Managers](https://awesome-repositories.com/f/business-productivity-software/markdown-note-managers.md) — Functions as a dedicated application for managing notes written in Markdown with support for math and diagrams. ([source](https://github.com/tw93/MiaoYan/blob/main/README_CN.md))
- [Bidirectional Linking](https://awesome-repositories.com/f/business-productivity-software/note-taking-search/note-tagging/bidirectional-linking.md) — Provides a system for creating bidirectional references between notes to build a connected personal knowledge graph.
- [Personal Knowledge Management](https://awesome-repositories.com/f/business-productivity-software/personal-knowledge-management.md) — Organizes local notes into a connected network using bidirectional links and backlinks.
- [Document Versioning](https://awesome-repositories.com/f/business-productivity-software/document-versioning.md) — Saves incremental snapshots of documents to allow users to review or restore previous versions of their work.

### Content Management & Publishing

- [Markdown Editors](https://awesome-repositories.com/f/content-management-publishing/content-formats-exporting/content-formats/markdown-editors.md) — Provides a high-performance editor for writing markdown content with syntax highlighting and asynchronous formatting. ([source](https://x.com/HiTw93/status/2020468635710755285))
- [Slide Parsing](https://awesome-repositories.com/f/content-management-publishing/content-management-systems/content-authoring-tools/markdown-based-content-authoring/markdown-based-content-authoring/slide-parsing.md) — Detects specific text markers within markdown files to split content into a sequence of presentation slides.
- [Document-to-Presentation Converters](https://awesome-repositories.com/f/content-management-publishing/content-processing-transformation/document-processing-conversion/document-processing-tools/format-conversion-toolkits/pdf-format-converters/web-to-pdf-converters/document-to-presentation-converters.md) — Transforms written markdown documents into structured presentation slide decks using specific separators. ([source](https://cdn.jsdelivr.net/gh/tw93/miaoyan@main/README.md))

### Data & Databases

- [Local File Storage](https://awesome-repositories.com/f/data-databases/data-engineering-infrastructure/data-persistence-storage/data-storage/file-based-storage/local-file-storage.md) — Persists documents and assets as local files to ensure data ownership and portability. ([source](https://x.com/HiTw93/status/2020468635710755285))
- [File-Based Storage Systems](https://awesome-repositories.com/f/data-databases/file-based-storage-systems.md) — Stores notes as local Markdown files to ensure data portability and compatibility with other text editors.

### Development Tools & Productivity

- [Markdown Editors](https://awesome-repositories.com/f/development-tools-productivity/code-editors-ides/extension-ecosystems-management/editor-extensions/text-editors/markdown-editors.md) — A high-performance desktop application for rendering and editing files written in Markdown syntax.
- [CLI File Managers](https://awesome-repositories.com/f/development-tools-productivity/cli-file-managers.md) — Offers a command-line interface to create, search, and open local documents without needing a graphical explorer.
- [Command Line Interfaces](https://awesome-repositories.com/f/development-tools-productivity/command-line-interfaces.md) — Provides a command-line interface for creating, searching, and opening documents without a GUI.
- [CLI Document Orchestrators](https://awesome-repositories.com/f/development-tools-productivity/local-file-syncing/cli-document-orchestrators.md) — Ships a CLI for managing the creation, discovery, and opening of local note files.

### User Interface & Experience

- [Side-by-Side Editor Previews](https://awesome-repositories.com/f/user-interface-experience/live-preview-integrations/side-by-side-editor-previews.md) — Provides a side-by-side editor and live preview with synchronized scrolling. ([source](https://github.com/tw93/MiaoYan/blob/main/README_CN.md))
- [Scroll Synchronization](https://awesome-repositories.com/f/user-interface-experience/live-preview-integrations/side-by-side-editor-previews/split-editor-groups/scroll-synchronization.md) — Align the editor and preview panes while scrolling or navigating through a document. ([source](https://x.com/HiTw93/status/2020468635710755285))
- [Markdown Slide Renderers](https://awesome-repositories.com/f/user-interface-experience/presentation-frameworks/web-based-presentation-authoring-tools/markdown-slide-renderers.md) — Transforms markdown content into a slide-based presentation format for audience display.
- [Outline-Based Slide Generators](https://awesome-repositories.com/f/user-interface-experience/text-outlining-tools/outline-based-slide-generators.md) — Generates presentation slides based on the structural markers and content within a markdown document.
- [View Modes](https://awesome-repositories.com/f/user-interface-experience/view-modes.md) — Allows users to toggle between standard preview and presentation viewing modes. ([source](https://x.com/HiTw93/status/2020468635710755285))

### Graphics & Multimedia

- [Automatic Diagram Renderers](https://awesome-repositories.com/f/graphics-multimedia/visualization-mapping/visualization-frameworks/automatic-diagram-renderers.md) — Automatically renders mathematical formulas and technical diagrams embedded within markdown content. ([source](https://cdn.jsdelivr.net/gh/tw93/miaoyan@main/README.md))

### Software Engineering & Architecture

- [Document Versioning](https://awesome-repositories.com/f/software-engineering-architecture/version-history-viewers/document-versioning.md) — Implements a system for tracking and recovering previous states of written notes.
