yn

Overview of yn

What it is

Yank Note is a highly extensible Markdown editor designed for productivity. It features version control, AI Copilot, document annotations, mind maps, document encryption, executable code snippets, chart embedding, HTML applets, plugins, and macro replacement. Its integrated sidebar terminal makes working with AI faster and more convenient.

Key features

• AI Assistant: Supports AI Copilot for text completion, generation, and image generation (compatible with OpenAI, Ollama, Gemini, Kimi, Tongyi Qianwen, Flux.1, etc.); supports OpenCode AI Agent for intelligent coding assistance.
• Version Control: Support backtracking document history versions.
• Encryption: files ending with .c.md are treated as encrypted files.
• Code running: support to run JavaScript, PHP, nodejs, Python, bash code.
• Plug-in extension: Support users to write their own plug-ins to expand the functionality of the editor.
• Embedded Applets: document supports embedded HTML Applets, PlantUML, drawio, ECharts, Mermaid, Luckysheet, etc.
• Macro replacement: support for embedded JavaScript expressions to dynamically replace document content.

Use cases

Writing and note-taking with Markdown, managing technical documentation with version control, using AI Copilot for content generation and code assistance, embedding diagrams and charts for visual documentation, running code snippets inline for tutorials or testing, encrypting sensitive notes, and extending functionality with custom plugins.

Getting started

See the repository README for installation instructions.

License and pricing

Licensed under AGPL-3.0. Open source and free to use.

Based on the project's public README and repository metadata.