## File: README.md # Yank Note A **highly extensible** Markdown editor, designed for productivity. **[Download](https://github.com/purocean/yn/releases)** | **[Try it Online >>>](https://demo.yank-note.com/)** [](https://apps.apple.com/cn/app/yank-note/id1551528618) [Not recommended](https://github.com/purocean/yn/issues/65#issuecomment-1065799677) English | [中文说明](./README_ZH-CN.md) | [Русский](./README_RU.md) [toc]{level: [2]} ## Highlights - **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.** - **Easy to use:** Use *Monaco* kernel, optimize for Markdown editing, and have the same editing experience as VSCode. - **Powerful:** Support version control; Applets, runnable code blocks, tables, PlantUML, Drawio, macro replacements, etc., can be embedded in the document. - **High compatibility:** Data is saved as local Markdown files, and the extension functions are implemented in the original syntax of Markdown as far as possible. - **Plug-in extension:** Support users to write their own plug-ins to expand the functionality of the editor. - **Encryption supported:** Use encryption to save private files such as account number, and the password can be set separately for each file. ## Attention - For more extendable, Yank Note sacrifices security protection (command execution, arbitrary file reading and writing). If you want to use it to open a foreign Markdown file, ⚠️**be sure to carefully identify whether the content of the file is trustworthy**⚠️. - The encryption and decryption of encrypted files are both completed at the front end. Please **be sure to remember your password**. Once the password is lost, it can only be cracked violently. ## Characteristic functions For more information on how to use the following functions, please see [characteristic functions description](./help/FEATURES.md) - **Sync scrolling:** the editing area and the preview area scroll synchronously, and the preview area can be scrolled independently - **Outline:** quickly jump to the corresponding location of the document through the directory outline in the preview area - **Version Control:** Support backtracking document history versions - **Encryption:** files ending with `.c.md` are treated as encrypted files - **Auto-save:** automatically save files after editing, with orange title bar reminder for unsaved files (encrypted documents are not automatically saved) - **Editing:** automatic completion of list - **Paste images:** you can quickly paste pictures from the clipboard and insert them as files or Base64 - **Embed attachments:** you can add attachments to the document and click to open them in the operating system. - **Code running:** support to run JavaScript, PHP, nodejs, Python, bash code - **To-do list:** support to display the to-do progress in the document. Click to quickly switch the to-do status. - **Quickly Open:** you can use shortcut key to open the file switch panel to quickly open files, tagged files, and full-text search for file contents. - **Integrated terminal:** support to open the terminal in the editor to quickly switch the current working directory - **LaTeX:** support LaTeX expression - **Style:** Markdown uses GitHub styles and features - **Repository:** multiple data locations can be defined for document classification - **External link conversion:** convert external link or Base64 pictures into local pictures - HTML resolving：you can use HTML code directly in the document, or use shortcut keys to copy and paste HTML to Markdown - **Multiple formats export:** the backend uses pandoc as converter - **TOC:** write `[toc]{type:** "ol", level:** [1,2,3]}` to generate TOC where you need to generate a directory - **Edit table cell:** double-click a table cell to quickly edit - **Copy title link:** copy title link path to the clipboard for easy insertion into other files - **Embedded Applets:** document supports embedded HTML Applets - **Embed PlantUML graphics:** document supports embedded plantUML graphics - **Embed drawio graphics:** document supports embedded drawio graphics - **Embed ECharts graphics:** document supports embedded Echarts graphics - **Embed Mermaid graphics:** document supports embedded Mermaid graphics - **Embed Luckysheet tables:** document supports embedded Luckysheet tables - **Mind map:** nested list can be displayed in the form of a mind map - **Element attribute writing:** any attribute of an element can be customized - **Table enhancement:** support table title with multiple lines of text, list and other features - **Document link:** support to link other documents in the document and jump to each other - **Footnote:** support writing footnotes in the document - **Custom container:** support custom containers similar to VuePress default themes - **Macro replacement:** support for embedded JavaScript expressions to dynamically replace document content - **Image hosting service:** support [PicGo](https://picgo.github.io/PicGo-Doc/) image hosting service - **Custom plug-ins:** support writing JavaScript plug-ins to expand editor functionality. The plug-in is placed in the `home directory/plugins`. Refer to [plug-in Development Guide](./help/PLUGIN.md) ## Screenshots ## Changelogs ### [v3.92.1](https://github.com/purocean/yn/releases/tag/v3.92.1) 2026-07-12 [Windows](https://github.com/purocean/yn/releases/download/v3.92.1/Yank-Note-win-x64-3.92.1.exe) | [macOS arm64](https://github.com/purocean/yn/releases/download/v3.92.1/Yank-Note-mac-arm64-3.92.1.dmg) | [macOS x64](https://github.com/purocean/yn/releases/download/v3.92.1/Yank-Note-mac-x64-3.92.1.dmg) | [Linux AppImage](https://github.com/purocean/yn/releases/download/v3.92.1/Yank-Note-linux-x86_64-3.92.1.AppImage) | [Linux deb](https://github.com/purocean/yn/releases/download/v3.92.1/Yank-Note-linux-amd64-3.92.1.deb) 1. feat(markdown): Upgrade Markdown-it to 14.3.0 and add CJK-friendly emphasis parsing for Chinese and Japanese text 2. feat(markdown): Add a raw HTML container that can render HTML blocks mixed with Markdown content 3. feat(plugin): Add range-based text highlighting APIs for extensions and preview interactions 4. feat(editor): Always show the floating editor hint so the feature remains discoverable 5. fix(markdown): Avoid double escaping plain-text code fences with a language marker 6. fix(editor): Restore HTML and other non-Markdown text files correctly when the app starts 7. fix(terminal): Prevent IME layout offsets caused by horizontal terminal overflow 8. chore: Upgrade Electron to 41 and update dependencies and security-related transitive packages [More release notes](https://github.com/purocean/yn/releases) ## Supports Wechat Group --- ## File: README_RU.md # Yank Note **Гибкий, расширяемый** редактор Markdown, создан для повышения производительности. **[Скачать](https://github.com/purocean/yn/releases)** | **[Попробовать онлайн >>>](https://demo.yank-note.com/)** [](https://apps.apple.com/cn/app/yank-note/id1551528618) [Не рекомендуется](https://github.com/purocean/yn/issues/65#issuecomment-1065799677) [English](./README.md) | [中文说明](./README_ZH-CN.md) | Русский [toc]{level: [2]} ## Особенности - **Помощник AI:** **Поддержка AI Copilot для автодополнения текста, генерации текста и изображений (совместимость с OpenAI, Ollama, Gemini, Kimi, Tongyi Qianwen, Flux.1 и др.); поддержка OpenCode AI Agent для интеллектуальной помощи в программировании.** - **Простота использования:** Используется ядро *Monaco*, оптимизированное для редактирования в формате Markdown, и возможности редактирования такие же, как у VSCode. - **Мощный:** Поддержка контроля версий; в документ можно встраивать апплеты, запускаемые блоки кода, таблицы, PlantUML, Drawio, макрозамены и т.д. - **Высокая совместимость:** Данные сохраняются в виде локальных файлов Markdown, а функции расширения реализованы в оригинальном синтаксисе Markdown, насколько это возможно. - **Расширение плагинов:** Поддержка пользователей в написании собственных плагинов для расширения функциональности редактора. - **Поддержка шифрования:** Используйте шифрование для сохранения приватных файлов, таких как номер счета, а пароль может быть установлен отдельно для каждого файла. ## Внимание - Ради большей расширяемости Yank Note жертвует защитой безопасности (выполнение команд, произвольное чтение и запись файлов). Если вы хотите использовать его для открытия постороннего файла Markdown, ⚠️**убедитесь, что содержимое файла заслуживает доверия**⚠️. - Шифрование и дешифрование зашифрованных файлов выполняется на клиентской стороне. Пожалуйста, **убедитесь, что вы помните свой пароль**. Если пароль утерян, его можно только взломать. ## Основнве функции Более подробную информацию об использовании следующих функций см. в разделе [описание основных функций](./help/FEATURES.md) - **Синхронная прокрутка:** область редактирования и область предварительного просмотра прокручиваются синхронно, а область предварительного просмотра можно прокручивать независимо - **Конспект:** быстрый переход к соответствующему месту документа через конспект в области предварительного просмотра - **Управление версиями:** поддержка истории документа - **Шифрование:** файлы, заканчивающиеся на `.c.md`, обрабатываются как зашифрованные - **Автосохранение:** автоматическое сохранение файлов после редактирования с напоминанием в строке заголовка для несохраненных файлов (зашифрованные документы не сохраняются автоматически) - **Редактирование:** автоматическое заполнение списка - **Вставка изображений:** вы можете быстро вставлять изображения из буфера обмена и вставлять их как файлы или Base64 - **Вложения:** вы можете добавлять вложения в документ и открывать их в операционной системе щелчком мыши - **Выполнение кода:** поддержка запуска JavaScript, PHP, nodejs, Python, кода bash - **Список задач:** поддержка отображения хода выполнения задач в документе. Щелкните, чтобы быстро переключить статус задачи - **Быстрое открытие:** вы можете использовать сочетание клавиш для открытия панели переключения файлов, чтобы быстро открывать файлы, помеченные файлы и выполнять полнотекстовый поиск по содержимому файлов - **Интегрированный терминал:** поддержка открытия терминала в редакторе для быстрого переключения текущего рабочего каталога - **LaTeX:** поддержка выражений LaTeX - **Стили:** Markdown использует стили и функции GitHub - **Репозиторий:** можно определить несколько расположений данных для организации документов - **Преобразование внешних ссылок:** преобразование внешних ссылок или изображений Base64 в локальные изображения - **Разрешение HTML:** вы можете использовать HTML-код непосредственно в документе или использовать сочетания клавиш для копирования и вставки HTML в Markdown - **Экспорт в несколько форматов:** backend использует pandoc в качестве конвертера - **TOC:** напишите `[toc]{type:** "ol", level:** [1,2,3]}` для генерации TOC (Table Of Content, оглавление), где вам нужно сгенерировать его - **Изменить ячейку таблицы:** дважды щелкните ячейку таблицы для быстрого редактирования - **Копирование ссылки на заголовок:** копирование пути ссылки на заголовок в буфер обмена для легкой вставки в другие файлы - **Встроенные апплеты:** документ поддерживает встроенные HTML-аплеты - **Встроенная графика PlantUML:** документ поддерживает встроенную графику plantUML - **Встроенная графика drawio:** документ поддерживает встроенную графику drawio - **Встроенная графика ECharts:** документ поддерживает встроенную графику Echarts - **Встроенная графика Mermaid:** документ поддерживает встроенную графику Mermaid - **Встроенные таблицы Luckysheet:** документ поддерживает встроенные таблицы Luckysheet - **Mind map:** вложенный список может быть отображен в виде интеллект-карты - **Запись атрибутов элемента:** любой атрибут элемента может быть настроен - **Улучшение таблиц:** поддержка заголовка таблицы с несколькими строками текста, списка и других функций - **Ссылка на документ:** поддержка ссылок на другие документы в документе и перехода друг к другу - **Сноска:** поддержка написания сносок в документе - **Пользовательский контейнер:** поддержка пользовательских контейнеров, аналогичных VuePress по умолчанию темы - **Макросы:** поддержка встроенных выражений JavaScript для динамической замены содержимого документа - **Служба хостинга изображений:** поддержка службы хостинга изображений [PicGo](https://picgo.github.io/PicGo-Doc/) - **Пользовательские плагины:** поддержка написания плагинов JavaScript для расширения функциональности редактора. Плагин находится в `home directory/plugins`. См. [руководство по разработке плагинов](./help/PLUGIN.md) ## Скриншоты ## Поддержка Wechat Group --- ## File: README_ZH-CN.md # Yank Note 一款**强大可扩展**的 Markdown 编辑器，为生产力而生。**[全平台下载](https://github.com/purocean/yn/releases)** ｜ **[在线体验>>>](https://demo.yank-note.com/)** [](https://apps.apple.com/cn/app/yank-note/id1551528618) [Mac App Store 版本说明](https://github.com/purocean/yn/issues/65#issuecomment-1065799677) [English](./README.md) | 中文说明 | [Русский](./README_RU.md) [toc]{level: [2]} ## 特色 - **AI 助手**：**支持 AI Copilot 进行文本补全、文本生成、图片生成（兼容 OpenAI、Ollama、Gemini、Kimi、通义千问、Flux.1 等）；支持 OpenCode AI Agent 智能编码辅助。** - **使用方便**：使用 Monaco 内核，专为 Markdown 优化，拥有和 VSCode 一样的编辑体验。 - **功能强大**：支持历史版本回溯；可在文档中嵌入小工具、可运行的代码块、表格、PlantUML 图形、Drawio 图形、宏替换等。 - **兼容性强**：数据保存为本地 Markdown 文件；拓展功能尽量用 Markdown 原有的语法实现。 - **插件拓展**：支持用户编写自己的插件来拓展编辑器的功能。 - **支持加密**：用来保存账号等隐私文件，文件可单独设置密码。 ## 注意事项 - 为了更高的拓展性和方便性，Yank Note 牺牲了安全防护（命令执行，任意文件读写）。如果要用它打开外来 Markdown 文件，⚠️**请务必仔细甄别文件内容是值得信任的**⚠️。 - 加密文件的加密解密操作均在前端完成，请**务必牢记自己的密码**。一旦密码丢失，就只能暴力破解了。 ## 特色功能 以下功能具体使用可参考[特色功能说明](./help/FEATURES_ZH-CN.md) - **同步滚动:** 编辑区和预览区同步滚动，预览区可独立滚动 - **目录大纲:** 预览区目录大纲快速跳转 - **版本管理:** 支持回溯文档历史版本 - **文件加密:** 以 `.c.md` 结尾的文件视为加密文件 - **自动保存:** 文件编辑后自动保存，未保存文件橙色标题栏提醒（加密文档不自动保存） - **编辑优化:** 列表自动补全 - **粘贴图片:** 可快速粘贴剪切板里面的图片，可作为文件或 Base64 形式插入 - **嵌入附件:** 可以添加附件到文档，点击在系统中打开 - **代码运行:** 支持运行 JavaScript、PHP、nodejs、Python、bash 代码 - **待办列表:** 支持显示文档中的待办进度，点击可快速切换待办状态 - **快速打开:** 可使用快捷键打开文件切换面板，以便快捷打开文件，标记的文件，全文搜索文件内容 - **内置终端:** 支持在编辑器打开终端，快速切换当前工作目录 - **公式解析:** 支持输入 LaTeX 公式代码 - **样式风格:** Markdown 使用 GitHub 风格样式和特性 - **数据仓库:** 可定义多个数据位置以便文档分类 - **外链转换:** 将外链或 BASE64 图片转换为本地图片 - **HTML 解析:** 可以直接在文档里面使用 HTML 代码，也可以使用快捷键粘贴复制 HTML 为 Markdown - **docx 导出:** 后端使用 pandoc 做转换器 - **TOC 支持:** 生成 TOC 在需要生成目录的地方写入 `[toc]{type: "ol", level: [1,2,3]}` 即可 - **编辑表格单元格:** 双击表格单元格即可快速编辑 - **复制标题链接:** 复制标题链接路径到剪切板，便于插入到其他文件 - **嵌入小工具:** 文档支持内嵌 HTML 小工具 - **嵌入 PlantUML 图形:** 在文档内内嵌 PlantUML 图形 - **嵌入 drawio 图形:** 在文档中内嵌 drawio 图形 - **嵌入 ECharts 图形:** 在文档中嵌入 Echarts 图形 - **嵌入 Mermaid 图形:** 在文档中嵌入 Mermaid 图形 - **嵌入 Luckysheet 表格:** 在文档中嵌入 Luckysheet 表格 - **嵌套列表转脑图展示:** 可将嵌套列表用脑图的方式展示 - **元素属性书写:** 可自定义元素的任意属性 - **表格解析增强:** 表格支持表格标题多行文本，列表等特性 - **文档交叉链接跳转:** 支持在文档中链接其他文档，互相跳转 - **脚注功能:** 支持在文档中书写脚注 - **容器块:** 支持类似 VuePress 默认主题的自定义容器 - **宏替换:** 支持内嵌 JavaScript 表达式动态替换文档内容 - **图床:** 支持 [PicGo](https://picgo.github.io/PicGo-Doc/) 图床 - **自定义插件:** 支持编写 JavaScript 插件拓展编辑器功能。插件放置在 `主目录/plugins` 中。参考[插件开发指南](./help/PLUGIN_ZH-CN.md) ## 截图 ## 更新日志 ### [v3.92.1](https://github.com/purocean/yn/releases/tag/v3.92.1) 2026-07-12 [Windows](https://github.com/purocean/yn/releases/download/v3.92.1/Yank-Note-win-x64-3.92.1.exe) | [macOS arm64](https://github.com/purocean/yn/releases/download/v3.92.1/Yank-Note-mac-arm64-3.92.1.dmg) | [macOS x64](https://github.com/purocean/yn/releases/download/v3.92.1/Yank-Note-mac-x64-3.92.1.dmg) | [Linux AppImage](https://github.com/purocean/yn/releases/download/v3.92.1/Yank-Note-linux-x86_64-3.92.1.AppImage) | [Linux deb](https://github.com/purocean/yn/releases/download/v3.92.1/Yank-Note-linux-amd64-3.92.1.deb) 1. feat(markdown): Markdown-it 升级到 14.3.0，并增加 CJK-friendly 强调解析，优化中文、日文文本的渲染 2. feat(markdown): 增加原始 HTML 容器，支持在 Markdown 内容中混合并直接渲染 HTML 区块 3. feat(plugin): 扩展 API 增加基于文本范围的高亮能力，供扩展和预览交互使用 4. feat(editor): 始终显示浮动编辑器提示，方便用户发现和使用该功能 5. fix(markdown): 修复带语言标记的纯文本代码围栏发生重复转义的问题 6. fix(editor): 修复应用启动时无法正确恢复 HTML 及其他非 Markdown 文本文件内容的问题 7. fix(terminal): 避免终端横向溢出导致输入法界面发生位置偏移 8. chore: Electron 升级到 41，并更新依赖和安全相关的间接依赖 [更多发布说明](https://github.com/purocean/yn/releases) ## 支持 加我微信进交流群（备注 Yank Note）