Yank Note

A Markdown note-taking application for programmers experience online>>>

[toc]{level: [2]}

Characteristics

• Easy to use：Use Monaco kernel, optimize for Markdown specially, and have the same editing experience as VSCode.
• Powerful function：Gadgets, runnable code blocks, tables, Plantuml graphics, Drawio graphics, macro replacements, etc., can be embedded in the document.
• Strong 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.

Notes

• Yank Note is a Markdown editor for programmers. The target application scenario is to write articles and take notes on the local machine.
• For greater expansibility and convenience, 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.

Yank-Note V3 Development Plan

The core goal of V3 is to refactor the code to improve application robustness, expansibility, and Markdown rendering performance.

V3 Project Board

• Build with Vite
• Optimize the performance of Markdown rendering, and support the extension of Vue component mode
• Refactor Electron code
• Refactor business logic, and decouple components
• Improve the documentation of custom plug-in
• Enhance document retrieval and citation experience
• Refactor the shortcut key processing layer, and support custom shortcut keys
• Other unfinished functions of V2
• Add mobile application

Characteristic functions

For more information on how to use the following functions, please see characteristic functions description

• Synchronous scrolling: the editing area and the preview area scroll synchronously, and the preview area can be scrolled independently
• Directory outline: quickly jump to the corresponding location of the document through the directory outline in the preview area
• File 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)
• Edit optimization: automatic completion of list
• Paste pictures: 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.
• Built-in terminal: support to open the terminal in the editor to quickly switch the current working directory
• Formula resolving: support to input katex formula code
• Style: Markdown uses GitHub styles and features
• Data 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 support: 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 gadgets: document supports embedded HTML gadgets
• Embed Plantuml graphics: you need to install Java and graphviz
• Embed drawio graphics：document supports embedded drawio graphics
• Embed ECharts graphics：document supports embeded Echarts graphics
• Embed Mermaid graphics：document supports embeded Mermaid graphics
• Embed Luckysheet tables：document supports embeded Luckysheet tables
• Nested list to mind map display: nested list can be displayed in the form of a mind map
• Element attribute writing: any attribute of an element can be customized
• Table resolving enhancement: support table title with multiple lines of text, list and other features
• Document cross-link jump: support to link other documents in the document and jump to each other
• Footnote function: support writing footnotes in the document
• Container blocks: 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 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

UI Screenshot

Update Log

Latest release

v3.11.7 2021-11-19

1. feat: add group container
2. feat(macro): add $export method
3. feat: add "New Folder" context menu
4. feat: add insert menu
5. upd: update shortcuts

Expand to see more version records

v3.11.6 2021-11-17

1. perf: optimize rendering large file performance
2. feat: add export button for echarts and mermaid

v3.11.5 2021-11-15

1. upd(mindmap): optimize the user experience
2. fix(main): fix startup crash when config.json is not exist

v3.11.3 2021-11-13

1. Add English language.
2. Macro definition supports asynchronous expressions.
3. Support quoting other document fragments in the document.
4. Fine-tune the UI.
5. Plug-in development:
   • Added service ctx.i18n.
   • Added method ctx.view.render.
   • Rename the hook VIEW_REFRESH to VIEW_AFTER_REFRESH.
   • Added hooks.
     • I18N_CHANGE_LANGUAGE
     • SETTING_FETCHED
     • SETTING_BEFORE_WRITE
     • VIEW_BEFORE_REFRESH

v3.10.3 2021-11-10

1. 修复长时间运行命令导致主进程阻塞问题
2. 修复代码块操作按钮滚动定位问题
3. 修复一些情况下渲染刷新问题
4. 插件：移除 ctx.bus 事件总线，使用钩子代替

v3.10.2 2021-11-05

1. 增加宏替换功能
2. 增加 Front Matter 解析
3. 增加标题序号展示
4. 切换待办状态支持快捷键 Alt + O
5. 其他若干问题修复和优化
6. 插件：ON_VIEW_ELEMENT_CLICK ON_VIEW_ELEMENT_DBCLICK 钩子中可以获取到 view dom

v3.9.4 2021-10-31

1. 修复 HTML 小工具编辑代码界面不更新问题
2. 修复 Windows 下终端不能正确切换目录问题
3. 其他交互体验优化
4. 插件开发：增加 ctx.document.isSameRepo 方法

v3.9.3 2021-10-29

1. HTML 小工具支持无边框展示
2. 只读模式文件树禁用一些右键菜单
3. 限制 js 代码不能在终端运行
4. 优化空白页展示
5. 修复大文档锚点跳转时预览滚动位置可能不正确
6. 插件开发：增加插件开发指南文档
7. 插件开发：ctx.shortcut 重命名为 ctx.command

v3.9.1 2021-10-28

1. 更新说明文档
2. 插件开发：ctx.api.proxyRequest 支持 Post 方式，传输大量数据

v3.9.0 2021-10-27

1. 增加自定义图片上传目录配置
2. 目录树菜单增加复制名称、复制路径功能
3. 插件开发：ctx 增加 args base 模块

v3.8.2 2021-10-24

1. 过于宽的表格增加横向滚动
2. 编辑器增加表格补全
3. 工具菜单增加更多内容
4. 导出默认使用 HTML 转换
5. 优化状态栏展示
6. 调整选中文本背景颜色

v3.8.0 2021-10-23

1. 增加 PicGo 图床支持
2. 文档没有目录时候隐藏目录按钮
3. 微调界面样式
4. 插件开发：ctx 增加 lib，可以使用一些安装的 npm 模块
5. 插件开发：新增临时文件接口
6. 插件开发：增加 ON_PASTE_IMAGE 钩子事件，用以拦截粘贴图片行为

v3.7.1 2021-10-21

1. 新增自定义容器块功能
2. 预览界面目录新增固定按钮
3. 终端优化：新增收起按钮、状态栏新增快速切换终端按钮
4. 上传附件和图片功能优化：增加多选、文件名保留原始文件名、路径增加 ./
5. 快捷键说明放置在单独文档

v3.6.9 2021-10-13

1. 微调样式

v3.6.8 2021-09-30

1. 新增自定义图片尺寸功能
2. 链接图标不使用背景方式，便于打印
3. 微调样式

v3.6.7 2021-09-18

1. 优化链接图标
2. 优化省略协议的链接解析
3. HTML 解析支持多行注释

v3.6.5 2021-09-16

1. 调整强制插入新行快捷键
2. 外部链接增加小图标
3. 修复表格鼠标悬停样式问题

v3.6.4 2021-09-09

1. 调整脚注展示
2. 修复目录动画闪烁问题
3. 修复终端中执行退出判定

v3.6.2 2021-09-08

1. 增加复制代码块按钮
2. 增加清空代码运行结果按钮
3. 标题锚点不再增加 h- 前缀
4. 微调 UI

v3.6.1 2021-09-06

1. 导出功能支持使用 Markdown 直接转换
2. Chrome 93 固定强调色
3. 优化输入建议

v3.6.0 2021-09-01

1. 增强导出功能，支持导出多种格式

v3.5.7 2021-08-26

1. 微调界面配色
2. 插件目录下的文件现在可以被访问
3. 编辑器上下文菜单增加粘贴相关功能
4. 优化内置终端语言判断和路径解析逻辑

v3.5.6 2021-08-20

1. 微调界面配色
2. 在内存中缓存代码运行结果

v3.5.5 2021-08-18

1. 微调界面配色
2. 图片支持行内模式展示

v3.5.3 2021-08-15

1. 修复点击配置菜单不工作问题
2. 修复一些 UI 展示问题
3. 优化一些交互体验

v3.5.2 2021-08-06

1. 浏览器中使用时候隐藏标题栏
2. 文档标签增加状态指示
3. 修复保存加密文件取消输入密码内容被还原问题
4. 修复一些 UI 展示问题
5. 优化一些交互体验

v3.5.1 2021-08-05

1. 调整界面基础字体为系统字体
2. 增加单独保存预览窗口滚动条位置
3. drawio 图形增加重载按钮
4. 修复复制标题链接有可能丢失 / 问题
5. 修复演示模式预览图片按 Esc 退出演示模式问题
6. 修复 drawio 网络慢的时候不能调整高度问题
7. 修复某些情况下切换演示模式页面样式不正确问题

v3.5.0 2021-08-03

1. 新增导航菜单，前进后退功能
2. 优化预览模式点击交互

v3.4.2 2021-08-02

1. 修复表格行号展示
2. 修复 Esc 快捷键冲突问题
3. 调整 macOS 上快捷键展示

v3.4.1 2021-08-01

1. 新增演示模式
2. 新增隐藏编辑器功能
3. 优化状态栏菜单展示

v3.3.7 2021-07-19

1. 修复帮助菜单不工作问题
2. 修复工具转换外链图片菜单不工作问题

v3.3.6 2021-07-16

1. 微调样式
2. 修复快捷键相关问题

v3.3.5 2021-07-14

1. 微调样式
2. 图片预览去掉播放按钮
3. 修复 Safari 不能打开嵌入页面问题
4. 修复对话框输入框意外触发确认问题

v3.3.4 2021-07-13

1. 修复终端主题不正确和不能正确初始化问题
2. 修复终端不能正确初始化问题
3. 修复表格不能插入图表问题

v3.3.3 2021-07-13

1. 嵌入文档表格增加统计栏
2. 修复表格保存校验问题
3. 修复标签颜色不正确问题

v3.3.2 2021-07-13

1. 增加浅色主题
2. 增加 Luckysheet 表格嵌入
3. 优化应用窗口使用体验

v3.2.2 2021-07-09

1. 优化文件切换体验，降低闪烁
2. HTML 小工具增加 ctx
3. 修复在终端中运行代码快捷键不正确
4. 修复本文档调整锚点不工作问题

v3.2.1 2021-07-08

1. 运行代码功能支持运行浏览器 JS 代码
2. 修正 Windows 更新报错问题
3. 修复编辑器菜单“终端运行”菜单行为
4. 调整标题仓库名展示位置

v3.2.0 2021-07-08

1. 编辑器增加右键菜单
2. 增加 Markdown 语法补全
3. 修复 Mermaid 图形编辑不能及时更新问题
4. 插件可拓展 Monaco Editor 功能
5. 重构编辑器相关代码

v3.1.2 2021-07-06

1. 插件 ctx 新增 api 接口
2. 调整运行代码样式

v3.1.1 2021-07-05

1. 增加图片预览功能

v3.1.0 2021-07-05

1. 增加转换文档的提示
2. 调整标题栏文件保存状态展示
3. 重构业务逻辑，和组件解耦

v3.0.3 2021-06-30

1. 优化添加仓库交互

v3.0.2 2021-06-28

1. 调整标题保存状态
2. 修复可能不能打开终端问题

v3.0.1 2021-06-27

1. 修复 Electron Scheme 模式下可能上传文件不成功问题

v3.0.0 2021-06-27

1. 大幅优化 Markdown 渲染性能，编辑更流畅
2. 修复部分遗留问题，增强 Katex 公式渲染，文件相对路径解析
3. 新增工具菜单
4. 修复 Ubuntu 上不展示应用图标问题

v2.9.10 2021-06-16

1. 增加双击编辑表格单元格功能

v2.9.9 2021-06-10

1. 修复 Scheme 模式下终端不能使用问题

v2.9.8 2021-06-10

1. 应用中打开页面增加 Scheme 模式

v2.9.7 2021-06-09

1. 修复在终端中打开路径错误问题

v2.9.6 2021-06-07

1. 修正 macOS 更新升级问题

v2.9.5 2021-06-07

1. 新增窗口应用菜单
2. 增加添加仓库提示，弃用默认仓库

v2.9.4 2021-06-06

1. 优化 macOS 上标题栏使用体验
2. 更换 macOS 应用图标

v2.9.3 2021-06-04

1. 关闭全部标签时候，忽略固定的标签
2. 修正某些情况下标签排序不正确问题

v2.9.2 2021-06-03

1. 新增固定标签页功能

v2.9.1 2021-06-02

1. 新增脑图保留上次使用布局
2. 修正 macOS 更新升级错误问题

v2.9.0 2021-05-29

1. 新增设置面板，更方便添加仓库
2. 微调部分控件的颜色和动画速度

v2.8.3 2021-05-29

1. 修正长时间运行后静态文件不能访问问题
2. 修正应用选中文字颜色不正确问题
3. 应用增加编辑菜单，以支持 macOS 上的复制粘贴快捷键
4. 微调滚动条样式

v2.8.2 2021-05-09

1. 修正快捷键判断问题
2. 升级 Electron 版本到 11.4.5

v2.8.1 2021-04-28

1. 修正目录树菜单不正确问题
2. 修正状态栏菜单无子菜单不能点击问题

v2.8.0 2021-04-27

1. 增加自定义插件功能
2. 微调窗口管理逻辑

v2.7.2 2021-04-09

1. 优化 macOS 上的窗口体验

v2.7.1 2021-04-08

1. 升级 Electron 到 11.4.2
2. 增加 Mac arm64 打包

v2.6.1 2021-03-04

1. 修正一点界面问题
2. 调整 macOS 升级逻辑

v2.6.0 2021-03-04

1. 内部功能插件化，增强拓展性
2. 微调界面样式
3. 修复复制代码快捷键不正确问题

v2.5.5 2021-02-03

1. 调整预览文字选择颜色

v2.5.4 2021-01-31

1. 调整 macOS 上应用边框样式
2. macOS 打包增加签名公证
3. 调整打包流程
4. 替换 plantuml 库

v2.5.1 2021-01-17

1. 支持 macOS
2. 调整部分快捷键

v2.4.11 2020-12-21

1. 修复不能导出 docx 问题
2. 修复大纲目录高度不正确

v2.4.10 2020-12-16

1. 优化脑图使用体验

v2.4.9 2020-12-15

1. 增加大纲列表脑图展示功能

v2.4.7 2020-12-02

1. 修复编辑表格跨列单元格问题

v2.4.6 2020-11-26

1. 增加编辑单元格内容功能

v2.4.5 2020-11-26

1. 移除代码表格的悬停样式

v2.4.4 2020-11-25

1. 更改 TOC 标号样式

v2.4.3 2020-11-25

1. 表格新增悬停样式：行号，突出当前行

v2.4.2 2020-11-20

1. 新增同步渲染按钮
2. 调整打印样式

v2.4.1 2020-10-27

1. 在 Electron 环境中开启缩放页面功能

v2.4.0 2020-10-26

1. Vue 框架升级到 3.0
2. 升级 Electron 版本
3. 升级前端依赖，更好的支持 Mermaid 图形

v2.3.8 2020-09-01

1. 增加开机自动启动功能

v2.3.7 2020-08-03

1. 优化预览鼠标事件响应

v2.3.6 2020-06-30

1. 升级 Electron 到 9.0.5

v2.3.5 2020-06-29

1. 增加脚注功能

v2.3.4 2020-06-28

1. 优化图片相对链接解析
2. 优化转换外链图片为本地图片功能

v2.3.3 2020-06-11

1. 修正标题过长导致大纲目录样式异常

v2.3.2 2020-04-27

1. 调整启动命令行参数

v2.3.1 2020-04-27

1. 增加配置监听端口命令行参数 --port=8080

v2.3.0 2020-04-27

1. 增加启动命令行参数

v2.2.11 2020-04-20

1. Drawio 文件渲染增加翻页按钮

v2.2.10 2020-04-07

1. 新增粘贴图片为 Base64 形式快捷键 Ctrl + B + V
2. 更改粘贴富文本为 Markdown 快捷键为 Ctrl + M + V

v2.2.9 2020-03-17

1. 修复公式解析问题

v2.2.8 2020-03-13

1. 增加切换编辑器标签快捷键 Ctrl + Alt + Left/Right

v2.2.7 2020-01-19

1. 调整渲染的表格宽度

v2.2.6 2020-01-16

1. 修复插入文档名称问题

v2.2.5 2020-01-14

1. 修复 frontend yarn.lock 问题

v2.2.4 2020-01-14

1. 修复 frontend yarn.lock 问题

v2.2.3 2020-01-13

1. 增加复制行内代码功能

v2.2.2 2019-12-27

1. 修复快速打开面板小问题

v2.2.1 2019-12-26

1. 修复跳转中文路径处理
2. 优化插入文档文件链接

v2.2.0 2019-12-25

1. 增加文档之间跳转功能
2. 增加复制文档标题链接功能
3. 调整文档插入选择面板
4. 修复高分辨率下目录树箭头消失问题

v2.1.1 2019-12-24

1. 增加在当前目录创建文件菜单
2. 限制快捷跳转列表数量以提高性能
3. 标题栏最大化窗口后移除尺寸调节

v2.1.0 2019-11-29

1. 增加多标签同时打开多个文件

v2.0.2 2019-11-21

1. 修复相对链接解析
2. 图片增加背景色便于透明图片的阅读

v2.0.1 2019-11-20

1. 增加 2.0 计划
2. Electron 打包
3. 增加 HTML 小工具渲染
4. 增加特色功能说明和示例
5. 目录树自动定位文件
6. 目录树增加右键菜单
7. 目录树和集成终端增加拖动调整尺寸功能
8. 使用自定义 UI 控件代替浏览器阻塞性弹出框，优化界面样式，提升交互体验
9. 默认仓库数据和配置改为在 <home>/yank-note 下保存
10. 重构前端代码便于拓展
11. 前端重构文件接口

v1.23.0 2019-07-09

1. 增加转换所有外链图片到本地功能 Ctrl + Alt + L

v1.22.0 2019-05-20

1. 增加粘贴 html 富文本功能 Ctrl + B + V
2. 增加插入文档快捷键 Ctrl + Alt + I
3. 修复 vue cli 3 打包错误
4. 修复图片链接转义
5. 搜索排除 node_modules
6. 上传文件目录优化

v1.21.0 2019-05-03

1. 调整抓取图片到本地的逻辑
2. 优化目录树样式
3. 目录树排除 node_modules
4. eslint 规则调整

v1.20.0 2019-04-18

1. 无功能变化，前端使用 vue cli 3

v1.19.0 2019-04-15

1. 增加终端打开目录功能 Ctrl + Alt + 单击目录
2. 增加刷新目录树功能 Ctrl + Alt + 单击目录

v1.18.2 2019-03-21

1. 保存加密文件密码不一致时增加提示
2. 修复样式问题

v1.18.1 2019-03-01

1. 修复目录样式
2. 修复代码块样式

v1.18.0 2019-02-28

1. 代码块增加行号显示
2. 支持统一文档锚点跳转
3. 移除 Mermaid 支持
4. 优化打印样式
5. 优化行内代码样式

v1.17.0 2019-02-20

1. 支持 ECharts 图形
2. Ctrl + Alt + R 在内置终端中运行选中代码

v1.16.2 2019-02-18

1. 文件树增加操作说明
2. 新增/重命名文件后打开新文件

v1.16.1 2019-02-17

1. 修复打印样式

v1.16.0 2019-02-16

1. 增加 Readme 展示
2. 处理终端退出逻辑

v1.15.1 2019-02-14

1. 更新 UI
2. 内置终端增加 windows 适配

v1.15.0 2019-02-13

1. 增加内置终端
2. 运行代码支持在内置终端运行

v1.14.0 2019-01-16

1. 上传附件增加日期
2. 快速跳转改用模糊搜索并高亮匹配项

v1.13.1 2019-01-14

1. 修复 hr 标签样式

v1.13.0 2019-01-05

1. 增加 toc
2. 增加返回顶部按钮

v1.12.0 2019-01-03

1. 增加连接行快捷键 Ctrl + J
2. 增加转换大小写快捷键 Ctrl + K, Ctrl + U Ctrl + K, Ctrl + L

v1.11.0 2019-01-02

1. 切换编辑器自动换行：Alt + W 或点击状态栏 切换换行 按钮

v1.10.0 2018-12-24

1. 文件列表自然排序
2. 文件目录增加子项目数量显示

v1.9.0 2018-11-12

1. 增加切换文档预览功能

v1.8.0 2018-08-29

1. 增加在系统中打开文件/目录功能 Ctrl + 双击文件/目录

v1.6 2018-08-22

1. 修复部分样式不和谐
2. 修复打开新文件编辑器滚动位置不正确
3. 增加将外链或 BASE64 图片转换为本地图片功能
4. 优化代码高亮在暗色主题下的展示
5. 渲染链接默认在新标签打开

v1.5.2 2018-08-13

1. 优化输入数字列表体验
2. 增加直接插入回车和Tab的快捷键
3. 确保文件最后有空行
4. 文件跳转按照最近打开文件排序

v1.5.1 2018-08-06

1. 修复打开上一次文件bug

v1.5 2018-08-06

1. 增加状态栏
2. 添加多仓库支持

v1.4 2018-08-02

1. 增加全文搜索功能
2. 修复公式定位问题

v1.3 2018-08-02

1. 增加待办记录时间
2. 增加 bat 脚本运行
3. 优化使用体验

v1.2 2018-07-30

1. 增加待办进度条展示

v1.1 2018-07-29

1. 修复若干问题
2. 增加附件插入
3. 调整为暗色主题
4. 图片新标签预览
5. 增加文件筛选面板 Ctrl + p