Foam is a personal knowledge management system built on VS Code and GitHub for linking, navigating and publishing Markdown notes.
- Stars
- 6,777
- Forks
- 922
- Open issues
- 75
- Last commit
- 5 days ago
What is it?
Yank Note is a desktop Markdown editor built on the Monaco editor kernel, so its editing experience is close to VS Code. Documents are stored as local Markdown files, and extra features such as applets, runnable code blocks, tables, PlantUML, drawio, and macro replacements are embedded using Markdown syntax as far as possible.
The editor covers a broad set of writing and note-taking needs: document version history, per-file encryption for files ending in .c.md, a mind map view generated from nested lists, outline navigation, and export to multiple formats through pandoc. It can embed ECharts, Mermaid, Luckysheet tables, and LaTeX expressions, and it includes an integrated terminal in the sidebar.
AI features include a Copilot for text completion, generation, and image generation that works with OpenAI, Ollama, Gemini, and other providers, along with an OpenCode AI agent for coding assistance. Users can also write JavaScript plugins to extend the editor. Because it runs code and reads files, the project warns that untrusted Markdown files should not be opened without checking their content.
Key features
- 01Monaco-based editor with VS Code-like editing and Markdown optimizations
- 02Document version history with rollback
- 03Per-file encryption for files ending in .c.md
- 04Runnable code blocks for JavaScript, Python, PHP, Node.js, and bash
- 05Embedded PlantUML, drawio, Mermaid, ECharts, and Luckysheet graphics
- 06AI Copilot compatible with OpenAI, Ollama, and Gemini, plus JavaScript plugin support
Use cases
- Writing technical notes that combine text, diagrams, and runnable code
- Keeping private documents encrypted on a local machine
- Drafting content with an AI assistant while keeping files as plain Markdown
- Exporting Markdown notes to other formats through pandoc
Quick start
- 1
Download the installer for your platform from the releases page
- 2
Install and open the downloaded app (Windows .exe, macOS .dmg, or Linux AppImage/deb)
Things to know
- Licensed under AGPL-3.0, a copyleft license that requires derivative works to be open-sourced under the same terms.
- To allow extensibility, it sacrifices security protection, including command execution and arbitrary file access, so untrusted Markdown files can be dangerous to open.
- Encrypted files are decrypted only on the front end, so a lost password cannot be recovered.
In collections
Topics
FAQ
- What is yn?
- A highly extensible Markdown editor with version control, AI Copilot, embedded diagrams, runnable code blocks, and file encryption. Yank Note is a desktop Markdown editor built on the Monaco editor kernel, so its editing experience is close to VS Code. Documents are stored as local Markdown files, and extra features such as applets, runnable code blocks, tables, PlantUML, drawio, and macro replacements are embedded using Markdown syntax as far as possible.
- Is yn free to use? What license does it have?
- yn is open source under the AGPL-3.0 license. Check the license terms before using it in commercial products.
- Is yn still maintained?
- Actively maintained. The last commit to yn was on Nov 3, 2026.
- What can I use yn for?
- Writing technical notes that combine text, diagrams, and runnable code Keeping private documents encrypted on a local machine Drafting content with an AI assistant while keeping files as plain Markdown Exporting Markdown notes to other formats through pandoc
- How do I install yn?
- Download the installer for your platform from the releases page Install and open the downloaded app (Windows .exe, macOS .dmg, or Linux AppImage/deb)
- Where can I get yn?
- The source code and installation instructions are on GitHub: https://github.com/purocean/yn
Summary generated by AI from the project's README. GitHub stats refresh daily.
Related projects
A native macOS Markdown note app that stores notes as plain files in a folder you choose, with split editor and preview.
A free, open-source desktop and self-hosted note-taking app for building large hierarchical personal knowledge bases.
A desktop Markdown editor for writing, note-taking with Zettelkasten linking, citations, and exporting to Pandoc, LaTeX and Word formats.
Self-hosted web app that runs the Obsidian note-taking app in a browser, keeping your vault on your own server.
A local, private markdown editor with WYSIWYG editing and side-by-side AI editing through Claude, Codex and other agents via MCP and CLI.