tw93/MiaoYan
MiaoYan
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.
Features
- Local-First Note Taking - A local-first markdown editor for writing technical notes with live side-by-side previews.
- Markdown Note Managers - Functions as a dedicated application for managing notes written in Markdown with support for math and diagrams.
- Bidirectional Linking - Provides a system for creating bidirectional references between notes to build a connected personal knowledge graph.
- Personal Knowledge Management - Organizes local notes into a connected network using bidirectional links and backlinks.
- Markdown Editors - Provides a high-performance editor for writing markdown content with syntax highlighting and asynchronous formatting.
- Local File Storage - Persists documents and assets as local files to ensure data ownership and portability.
- File-Based Storage Systems - Stores notes as local Markdown files to ensure data portability and compatibility with other text editors.
- Markdown Editors - A high-performance desktop application for rendering and editing files written in Markdown syntax.
- Side-by-Side Editor Previews - Provides a side-by-side editor and live preview with synchronized scrolling.
- Document Versioning - Saves incremental snapshots of documents to allow users to review or restore previous versions of their work.
- Slide Parsing - Detects specific text markers within markdown files to split content into a sequence of presentation slides.
- Document-to-Presentation Converters - Transforms written markdown documents into structured presentation slide decks using specific separators.
- CLI File Managers - Offers a command-line interface to create, search, and open local documents without needing a graphical explorer.
- Command Line Interfaces - Provides a command-line interface for creating, searching, and opening documents without a GUI.
- CLI Document Orchestrators - Ships a CLI for managing the creation, discovery, and opening of local note files.
- Automatic Diagram Renderers - Automatically renders mathematical formulas and technical diagrams embedded within markdown content.
- Document Versioning - Implements a system for tracking and recovering previous states of written notes.
- Scroll Synchronization - Align the editor and preview panes while scrolling or navigating through a document.
- Markdown Slide Renderers - Transforms markdown content into a slide-based presentation format for audience display.
- Outline-Based Slide Generators - Generates presentation slides based on the structural markers and content within a markdown document.
- View Modes - Allows users to toggle between standard preview and presentation viewing modes.
- Markdown 编辑器 - Listed in the “Markdown 编辑器” section of the Great Open Source Project awesome list.
