purocean/yn

Yank Note (yn)

What it is – Yank Note is a cross‑platform, Electron‑based Markdown editor that aims to be a one‑stop workspace for writing, coding, and visualising documents. It stores everything as ordinary Markdown files, so the data remains portable and can be edited with any other tool.

Why it matters for an AI‑curious audience – The editor bundles an AI Assistant that can call large‑language‑model back‑ends (OpenAI, Ollama, Gemini, Kimi, Tongyi Qianwen, etc.) for text completion, generation and even image generation (Flux 1, etc.). It also ships an OpenCode AI Agent that offers coding‑related help inside the editor. This makes Yank Note a practical example of how LLMs can be embedded into everyday productivity software.

Key capabilities

• AI Copilot – Prompt‑based completion, generation, and image creation via a configurable list of LLM providers.
• OpenCode AI Agent – Context‑aware coding assistance, useful for writing scripts in the many runnable code blocks the editor supports.
• Monaco‑based editing – The same editing experience as VS Code, with syntax‑aware autocomplete, list auto‑completion, and markdown‑specific shortcuts.
• Live preview & sync scrolling – The editor pane and rendered preview stay in sync, with the option to scroll them independently.
• Version control – Built‑in history tracking lets you roll back document changes without leaving the app.
• Rich embed support – PlantUML, Drawio, Mermaid, ECharts, Luckysheet tables, mind‑maps, LaTeX, and arbitrary HTML/Applets can be inserted directly in the markdown.
• Executable code blocks – JavaScript, PHP, Node.js, Python, Bash, etc., can be run inside the document, turning notes into interactive notebooks.
• Plug‑in system – Users can drop JavaScript plug‑ins into ~/.yn/plugins to extend the UI or add new behaviours.
• Encryption – Files ending with .c.md are encrypted client‑side; the password is never sent to a server.
• Export – Uses Pandoc under the hood to produce PDF, HTML, Word, and other formats.

How to get started

1. Download the binary for Windows, macOS, or Linux from the Release page (or try the web demo at https://demo.yank-note.com).
2. Open or create a .md file. The editor will automatically render a preview on the right.
3. To enable the AI assistant, open the Settings → AI panel, select a provider (e.g., OpenAI), and paste your API key.
4. Use the shortcut Ctrl+Space (or the configured hot‑key) to invoke the copilot in the current cursor location.
5. For code execution, write a fenced block like python … and click the run button that appears in the block header.
6. Explore the plug‑in folder (~/.yn/plugins) and follow the bundled PLUGIN.md guide to write your own extensions.

Caveats

• The app runs user‑provided code and can execute arbitrary shell commands; opening untrusted markdown files may be risky.
• Encryption/decryption happens entirely in the browser/Electron front‑end – losing the password means the file is effectively unrecoverable.

Community & support

• Official WeChat group (QR code shown in the repo) for real‑time help.
• Issue tracker on GitHub for bug reports and feature requests.

Bottom line – Yank Note is a full‑featured markdown editor that demonstrates how LLMs can be woven into desktop productivity tools, offering both general‑purpose writing assistance and specialised coding help while keeping the core data in plain markdown files.