Yank Note
一款面向程序员的 Markdown 笔记应用
[toc]{level: [2]}
特色
- 使用方便：使用 Monaco 编辑器（vscode 编辑器内核）编辑，针对 Markdown 文件添加了快捷键和补全规则
- 兼容性强：资源保存本地，Markdown 文件可简单处理离线工作；拓展功能尽量用 Markdown 原有的语法实现
- 高拓展性：可在文档中嵌入小工具、可运行的代码块、ECharts 图形、Plantuml 图形、Drawio 图形等
- 支持加密：用来保存账号等隐私文件，文件可单独设置密码
注意事项
- Yank Note 是一款针对程序员的 Markdown 编辑器，目标应用场景为在本机写文章、日志、笔记，编写小工具。
- 为了更高的拓展性和方便性，Yank Note 牺牲了安全防护（命令执行，任意文件读写）。如果要用它打开外来 Markdown 文件，请务必仔细甄别文件内容是值得信任的。
- 如果要改造为对外的 Web 服务，请运行在隔离可控的环境下，注意应用安全。
- 加密文件的加密解密操作均在前端完成，请务必保管好自己的密码。一旦密码丢失，就只能暴力破解了。
Yank-Note 2.0 开发计划
- 项目更名为 Yank-Note
- 前端界面可以拖动调整尺寸
- 重构前端项目结构，便于拓展：引入
vuex，使用async await代替可怕的回调，规范文件接口 - 暴露 Api 接口可以在文档中嵌入轻量应用，以便构建一些小工具
- 使用
Electron构建为桌面应用。不追求完全做成客户端，还是可以沿用 CS 架构。同样可以在浏览器中使用 - 支持嵌入
draw.io文档 - 文件目录增加右键菜单
- 支持多标签打开多个文件
- 拥有更友好的配置界面
- 可以自定义快捷键
特色功能
- 同步滚动：编辑区和预览区同步滚动，预览区可独立滚动
- 目录大纲：预览区目录大纲快速跳转
- 文件加密：以
.c.md结尾的文件视为加密文件 - 自动保存：文件编辑后自动保存，未保存文件橙色标题栏提醒（加密文档不自动保存）
- 编辑优化：列表自动补全
- 粘贴图片：
Ctrl + V粘贴剪切板里面的图片，使用快捷键Ctrl + B + V作为 Base64 形式粘贴 - 嵌入附件：可以添加附件到文档，点击在系统中打开
- 代码运行：支持运行 PHP，nodejs，Python，bash 代码，示例见 FEATURE.md
- 待办列表：支持显示文档中的待办进度，点击可快速切换待办状态
- 快速打开：可使用快捷键
Ctrl + P打开文件切换面板，以便快捷打开文件，标记的文件，全文搜索文件内容 - 内置终端：支持在编辑器打开终端，快速切换当前工作目录
- 公式解析：支持输入 katex 公式代码
- 样式风格：Markdown 使用 GitHub 风格样式和特性
- 数据仓库：可定义多个数据位置以便文档分类
- 外链转换：将外链或 BASE64 图片转换为本地图片：
Ctrl + Shift + 单击图片Ctrl + Alt + L转换所有外链图片到本地 - HTML 解析：可以直接在文档里面使用 HTML 代码，也可以使用快捷键
Ctrl + M + V粘贴复制 HTML 为 Markdown - docx 导出：后端使用 pandoc 做转换器
- TOC 支持：生成 TOC 在需要生成目录的地方写入
[toc]{type: "ol", level: [1,2,3]}即可，，示例见 FEATURE.md - 复制标题链接：
Ctrl + 单击标题复制标题链接路径到剪切板，便于插入到其他文件 - 嵌入小工具：文档支持内嵌 HTML 小工具，示例见 FEATURE.md
- 嵌入 Plantuml 图形：需要安装 Java，graphviz ，示例见 FEATURE.md
- 嵌入 drawio 图形：文档支持内嵌 drawio 图形，示例见 FEATURE.md
- 嵌入 ECharts 图形：在文档中嵌入 Echarts 图形，示例见 FEATURE.md
- 嵌入 Mermaid 图形：在文档中嵌入 Mermaid 图形，示例见 FEATURE.md
- 元素属性书写：可自定义元素的任意属性，示例见 FEATURE.md
- 表格解析增强：表格支持表格标题多行文本，列表等特性，示例见 FEATURE.md
- 文档交叉链接跳转：支持在文档中引入其他文档，互相跳转
- 脚注功能：支持在文档中书写脚注
上手使用
- 在 最新版本 下载对应平台应用即可
- 默认快捷键参考 vscode
Ctrl + X剪切所选/当前行Ctrl + C复制所选/当前行Ctrl + Z撤消Ctrl + Shift + Z反撤消Ctrl + /注释行Ctrl + Shift + A注释段Ctrl + K, Ctrl + X删除尾部空格Alt + Click插入光标Shift + Alt + ↑/↓在相邻行插入光标Ctrl + U取消最后添加的光标Shift + Alt + I在选中区的所有行的最后添加光标Ctrl + D为下一个匹配项添加光标Ctrl + F查找Ctrl + H替换
- 自定义编辑器快捷键
Ctrl + P打开文件快速跳转面板Ctrl + S保存文档Ctrl + Enter强制插入新行，忽略预置补全规则Shift + Enter强制插入 Tab，忽略预置补全规则Ctrl + Shift + Up当前行上移Ctrl + Shift + Down当前行下移Ctrl + Shift + D重复当前行Ctrl + Alt + D插入当前日期Ctrl + Alt + T插入当前时间Ctrl + Alt + F插入文件附件Ctrl + Alt + I插入文档链接Ctrl + J连接行 join linesCtrl + K, Ctrl + U转换大写Ctrl + K, Ctrl + L转换小写Ctrl + Alt + R在内置终端里面运行选中内容Ctrl + M + V粘贴 html 富文本Ctrl + B + V粘贴图片为 Base64Ctrl + Alt + Left/Right切换编辑器 Tab
开发
依赖安装和编译比较麻烦，请保证自己有足够耐心且有科学上网的手段。
Windows
Windows 上安装 node-pty 需要费一番功夫，请参考 https://github.com/microsoft/node-pty#windows 配置编译环境。
REM Node 版本要求 12 v12.7.0
node -v
REM 前端
cd frontend
REM 安装依赖
yarn
REM 打包
yarn run dist
REM 开发
yarn run serve
REM Electron 端
cd ../
REM 安装依赖
win-install.bat
REM 打包 打包前请在前端目录运行打包命令
win-build.bat
REM 开发
yarn run startLiunx
TODO 手头没有环境，待完善
OSX
TODO 手头没有环境，待完善
界面截图
更新日志
v2.3.8 2020-09-01
- 增加开机自动启动功能
展开查看更多版本记录
v2.3.8 2020-08-03
- 优化预览鼠标事件响应
v2.3.6 2020-06-30
- 升级 Electron 到 9.0.5
v2.3.5 2020-06-29
- 增加脚注功能
v2.3.4 2020-06-28
- 优化图片相对链接解析
- 优化转换外链图片为本地图片功能
v2.3.3 2020-06-11
- 修正标题过长导致大纲目录样式异常
v2.3.2 2020-04-27
- 调整启动命令行参数
v2.3.1 2020-04-27
- 增加配置监听端口命令行参数
--port=8080
v2.3.0 2020-04-27
- 增加启动命令行参数
v2.2.11 2020-04-20
- Drawio 文件渲染增加翻页按钮
v2.2.10 2020-04-07
- 新增粘贴图片为 Base64 形式快捷键
Ctrl + B + V - 更改粘贴富文本为 Markdown 快捷键为
Ctrl + M + V
v2.2.9 2020-03-17
- 修复公式解析问题
v2.2.8 2020-03-13
- 增加切换编辑器标签快捷键
Ctrl + Alt + Left/Right
v2.2.7 2020-01-19
- 调整渲染的表格宽度
v2.2.6 2020-01-16
- 修复插入文档名称问题
v2.2.5 2020-01-14
- 修复 frontend yarn.lock 问题
v2.2.4 2020-01-14
- 修复 frontend yarn.lock 问题
v2.2.3 2020-01-13
- 增加复制行内代码功能
v2.2.2 2019-12-27
- 修复快速打开面板小问题
v2.2.1 2019-12-26
- 修复跳转中文路径处理
- 优化插入文档文件链接
v2.2.0 2019-12-25
- 增加文档之间跳转功能
- 增加复制文档标题链接功能
- 调整文档插入选择面板
- 修复高分辨率下目录树箭头消失问题
v2.1.1 2019-12-24
- 增加在当前目录创建文件菜单
- 限制快捷跳转列表数量以提高性能
- 标题栏最大化窗口后移除尺寸调节
v2.1.0 2019-11-29
- 增加多标签同时打开多个文件
v2.0.2 2019-11-21
- 修复相对链接解析
- 图片增加背景色便于透明图片的阅读
v2.0.1 2019-11-20
- 增加 2.0 计划
- Electron 打包
- 增加 HTML 小工具渲染
- 增加特色功能说明和示例
- 目录树自动定位文件
- 目录树增加右键菜单
- 目录树和集成终端增加拖动调整尺寸功能
- 使用自定义 UI 控件代替浏览器阻塞性弹出框，优化界面样式，提升交互体验
- 默认仓库数据和配置改为在
<home>/yank-note下保存 - 重构前端代码便于拓展
- 前端重构文件接口
v1.23.0 2019-07-09
- 增加转换所有外链图片到本地功能
Ctrl + Alt + L
v1.22.0 2019-05-20
- 增加粘贴 html 富文本功能
Ctrl + B + V - 增加插入文档快捷键
Ctrl + Alt + I - 修复 vue cli 3 打包错误
- 修复图片链接转义
- 搜索排除 node_modules
- 上传文件目录优化
v1.21.0 2019-05-03
- 调整抓取图片到本地的逻辑
- 优化目录树样式
- 目录树排除 node_modules
- eslint 规则调整
v1.20.0 2019-04-18
- 无功能变化，前端使用 vue cli 3
v1.19.0 2019-04-15
- 增加终端打开目录功能
Ctrl + Alt + 单击目录 - 增加刷新目录树功能
Ctrl + Alt + 单击目录
v1.18.2 2019-03-21
- 保存加密文件密码不一致时增加提示
- 修复样式问题
v1.18.1 2019-03-01
- 修复目录样式
- 修复代码块样式
v1.18.0 2019-02-28
- 代码块增加行号显示
- 支持统一文档锚点跳转
- 移除
Mermaid支持 - 优化打印样式
- 优化行内代码样式
v1.17.0 2019-02-20
- 支持
ECharts图形 Ctrl + Alt + R在内置终端中运行选中代码
v1.16.2 2019-02-18
- 文件树增加操作说明
- 新增/重命名文件后打开新文件
v1.16.1 2019-02-17
- 修复打印样式
v1.16.0 2019-02-16
- 增加 Readme 展示
- 处理终端退出逻辑
v1.15.1 2019-02-14
- 更新 UI
- 内置终端增加 windows 适配
v1.15.0 2019-02-13
- 增加内置终端
- 运行代码支持在内置终端运行
v1.14.0 2019-01-16
- 上传附件增加日期
- 快速跳转改用模糊搜索并高亮匹配项
v1.13.1 2019-01-14
- 修复 hr 标签样式
v1.13.0 2019-01-05
- 增加 toc
- 增加返回顶部按钮
v1.12.0 2019-01-03
- 增加连接行快捷键
Ctrl + J - 增加转换大小写快捷键
Ctrl + K, Ctrl + UCtrl + K, Ctrl + L
v1.11.0 2019-01-02
- 切换编辑器自动换行：
Alt + W或点击状态栏切换换行按钮
v1.10.0 2018-12-24
- 文件列表自然排序
- 文件目录增加子项目数量显示
v1.9.0 2018-11-12
- 增加切换文档预览功能
v1.8.0 2018-08-29
- 增加在系统中打开文件/目录功能
Ctrl + 双击文件/目录
v1.6 2018-08-22
- 修复部分样式不和谐
- 修复打开新文件编辑器滚动位置不正确
- 增加将外链或 BASE64 图片转换为本地图片功能
- 优化代码高亮在暗色主题下的展示
- 渲染链接默认在新标签打开
v1.5.2 2018-08-13
- 优化输入数字列表体验
- 增加直接插入回车和Tab的快捷键
- 确保文件最后有空行
- 文件跳转按照最近打开文件排序
v1.5.1 2018-08-06
- 修复打开上一次文件bug
v1.5 2018-08-06
- 增加状态栏
- 添加多仓库支持
v1.4 2018-08-02
- 增加全文搜索功能
- 修复公式定位问题
v1.3 2018-08-02
- 增加待办记录时间
- 增加 bat 脚本运行
- 优化使用体验
v1.2 2018-07-30
- 增加待办进度条展示
v1.1 2018-07-29
- 修复若干问题
- 增加附件插入
- 调整为暗色主题
- 图片新标签预览
- 增加文件筛选面板 Ctrl + p