✨Yank Note: A Powerful Extensible Markdown Editor Built for Productivity

Yank Note is an open-source Markdown editor built with TypeScript and Vue (6k+ GitHub stars), blending lightweight editing with IDE-level extensibility—featuring file encryption, code execution, and a plugin ecosystem.

I. Yank Note: When Markdown Meets the "Swiss Army Knife"

Yank Note is an open-source Markdown editor built with TypeScript and Vue (6k+ GitHub stars), designed for developers, technical writers, and productivity enthusiasts. It cleverly merges lightweight text editing with IDE-level extensibility, preserving Markdown's simplicity while delivering advanced features like document encryption, code execution, and version control through a plugin system—truly the "VSCode of the Markdown world."

II. Core Features: Beyond the Ceiling of Traditional Editors

1. Editing Enhancement Suite

• Column Editing Mode: Activate via Alt+Click, middle-mouse drag, or keyboard shortcut to batch-modify multiple lines (such as table data or code prefixes), dramatically boosting efficiency for structured content.
• Smart Syntax Awareness: Automatically detects code block regions and suppresses Markdown hints, avoiding interference during pure code editing.
• Dual-Pane Collaboration: Editor and preview panes support synchronized scrolling; the preview pane allows independent font adjustment (freely switch between monospace and serif).

2. Dynamic Content Embedding (A Technical Documentation Powerhouse)

• Executable Code Snippets: Run JS/Python/Bash code directly—debug scripts without switching to a terminal.
• Professional Diagram Support: Embedded Drawio drawing, Mermaid flowcharts, and ECharts data visualization.
• Reveal.js Integration: Write PPTs in Markdown, create slides with the --- separator, with support for transition animations and interactive controls.

3. Security & Version Management

• File-Level Encryption: Files with the .c.md extension enable front-end encryption; lost passwords can only be brute-forced, eliminating backdoor risks.
• Historical Version Rollback: Automatically saves editing history; roll back to any version at any time.

4. Extension Ecosystem

• Plugin Development: Provides the ctx API object; 50+ built-in plugins are open-source for reference, supporting Hook interception and Action customization (e.g., adding menus to the status bar).
• AI Integration: Connects to OpenAI for auto-completion, boosting technical documentation writing efficiency.

III. Installation & Configuration Guide

One-Click Cross-Platform Deployment

git clone https://github.com/purocean/yn.git
cd yn && yarn install && yarn dev

Essential Settings for Beginners

• Enable Encryption: Rename the file to XXX.c.md and set a password on first save.
• Bind an Image Host: Configure PicGo to auto-upload pasted images.
• Customize Preview Style: Switch between monospace and serif fonts via Settings > Appearance > Preview Font.

IV. Advanced Tips: Unleash the Productivity Potential

1. Document-as-PPT (Reveal.js Workflow)

• Create a new .md file and define slide titles with ##.
• Use the --- separator to create new slide pages.
• Insert Mermaid flowcharts or ECharts charts for enhanced visualization.
• Export to HTML or present directly in fullscreen.

2. Plugin Development in Practice (A 5-Line Code Example)

Create home-directory/plugins/hello.js:

window.registerPlugin({
  name: 'hello-plugin',
  register: ctx => {
    ctx.statusBar.addItem({
      id: 'hello-button',
      title: 'HELLO',
      onClick: () => alert('Yank Note!')
    })
  }
})

After restart, an interactive button appears in the status bar.

V. Side-by-Side Comparison: Why Developers Love Yank Note?

Data based on hands-on testing and community feedback.

• VS Sublime: Yank Note's repository-style document management fits knowledge base needs better, while Sublime offers more flexible multi-cursor editing.
• VS Yuque: Yank Note's local storage + offline operation suits privacy-sensitive scenarios; Yuque excels at team collaboration but depends on the network.

VI. Security Warning: Balancing Capability and Risk

Yank Note sacrifices some security protections for extensibility:

• ⚠️ Command Execution Risk: Running external Markdown files may trigger malicious code—always verify content trustworthiness!
• ⚠️ Irreversible Encryption: Lost passwords will permanently lock the file (no server-side key backup).

Conclusion: Who Should Choose Yank Note?

• 👍 Recommended Users: Technical documentation writers, Markdown power users, privacy-focused note-takers, plugin tinkerers.
• 👎 Use with Caution: Pure mobile users (no official app), non-technical users seeking plug-and-play simplicity.

Project Update: The v3.82.1 release in June 2025 added preview font customization and API enhancements, continuously optimizing the professional writing experience.

Access Channels:

• Source Repository: GitHub - purocean/yn
• Stable Release Download: Official Download Page

With technology reshaping writing, Yank Note has carved its own path on the tightrope between openness and security—this may well be the ultimate form of editor in an engineer's mind.

Note: This is the English translation of the original Chinese version.