- 一、概述
- 二、命令
- 1. 小书匠应用命令
- 1-1. save
- 1-2. saveAs
- 1-3. saveInternal
- 1-4. preview
- 1-5. zenWriter
- 1-6. zenReader
- 1-7. toggleStore
- 1-8. toggleSidebar
- 1-9. toggleOnlyPreview
- 1-10. preventToDefault
- 1-11. passToDefault
- 1-12. exportFiles
- 1-13. toggleEditorTocPanel
- 1-14. togglePreviewTocPanel
- 1-15. toggleFileListPanel
- 1-16. toggleToolPanel
- 1-17. toggleVimMode
- 1-18. toggleEmacsMode
- 1-19. setFileModelAttribute
- 1-20. insertSnippet
- 1-21. xsj_bold
- 1-22. xsj_italic
- 1-23. xsj_anchor
- 1-24. xsj_footnote
- 1-25. xsj_mark
- 1-26. xsj_link
- 1-27. xsj_moment
- 1-28. xsj_html
- 1-29. xsj_toc
- 1-30. xsj_magent
- 1-31. xsj_quote
- 1-32. xsj_code
- 1-33. xsj_image
- 1-34. xsj_olist
- 1-35. xsj_ulist
- 1-36. xsj_tlist
- 1-37. xsj_fonticon
- 1-38. xsj_table
- 1-39. xsj_ntable
- 1-40. xsj_drawio
- 1-41. xsj_hr
- 1-42. xsj_undo
- 1-43. xsj_redo
- 1-44. xsj_heading
- 2. ace 编辑器命令
- 3. codemirror 编辑器命令
- 4. 小书匠客户端命令
- 1. 小书匠应用命令
- 三、相关
一、概述
小书匠从 7.8.7
版本开始支持自定义快捷键功能,相应的开放了部份命令。该文档列出了小书匠目前支持的所有命令。
二、命令
命令是用来执行一定的功能,比如保存,打开预览,选择文字等。
小书匠支持四种命令类型, 小书匠应用命令, ace 命令, codemirror 命令, 小书匠客户端命令
所有命令都有默认生效范围, 小书匠应用命令默认在非编辑区,非预览区内点击想应的默认快捷键,命令才会生效。 ace 命令只有在 使用 ace 编辑器,并且在编辑区内触发快捷键时,才会生效。 codemirror 命令只有在使用 codemirror 编辑器,并且在编辑区内触发快捷键时,才会生效。而小书匠客户端命令,只有在小书匠客户端状态下生效,小书匠 web 版本没有客户端命令。
1. 小书匠应用命令
1-1. save
保存操作
如果用户绑定了第三方存储,并指定为默认存储时,会同步触发第三方存储的同步
默认快捷键 ctrl+s
1-2. saveAs
另存为
默认快捷键 ctrl+shift+s
1-3. saveInternal
保存操作(与 save
命令不同的是,该命令不会触发第三方存储同步)
1-4. preview
打开或者关闭预览
默认快捷键 ctrl+shift+p
1-5. zenWriter
全屏写作
默认快捷键 ctrl+shift+1
1-6. zenReader
全屏阅读
默认快捷键 ctrl+shift+2
1-7. toggleStore
打开文件列表
默认快捷键 ctrl+shift+f
1-8. toggleSidebar
打开侧边菜单栏
默认快捷键 ctrl+shift+b
1-9. toggleOnlyPreview
进入纯阅读模式
1-10. preventToDefault
禁用该快捷键
1-11. passToDefault
取消快捷键
用于对默认快捷键的取消功能,比如想取消 ctrl+s 原有的默认绑定,可以添加该命令
1-12. exportFiles
导出文件
1-13. toggleEditorTocPanel
打开编辑区大纲面板
1-14. togglePreviewTocPanel
打开预览区大纲面板
1-15. toggleFileListPanel
打开或者关闭文件列表
默认快捷键 ctrl+left
1-16. toggleToolPanel
打开或者关闭工具栏
默认快捷键 ctrl+up
1-17. toggleVimMode
打开或者关闭 vim 模式(需要使用的内置编辑器支持 vim 按键)
1-18. toggleEmacsMode
打开或者关闭 emacs 模式 (需要使用的内置编辑器支持 emacs 按键)
1-19. setFileModelAttribute
修改选中文件的属性
需要指定两个参数,第一个参数为要修改的属性('tagNames', 'category', 'flag'),第二个参数为对应属性的值,两个参数之间需要用空格分开。
1-20. insertSnippet
快速输入一个片段
需要指定一个片段 id 做为输入参数,如果不指定片段 id或者片段 id 不存在, 系统直接使用默认片段
1-21. xsj_bold
加粗
默认快捷键 ctrl+b
1-22. xsj_italic
斜体
默认快捷键 ctrl+i
1-23. xsj_anchor
锚点
1-24. xsj_footnote
脚注
1-25. xsj_mark
高亮
默认快捷键 ctrl+m
1-26. xsj_link
链接
默认快捷键 ctrl+l
1-27. xsj_moment
输入当前时间
默认快捷键 ctrl+.
1-28. xsj_html
html 转换成 markdown
1-29. xsj_toc
输入静态大纲
1-30. xsj_magent
图床迁移
1-31. xsj_quote
引用
默认快捷键 ctrl+q
1-32. xsj_code
代码块
默认快捷键 ctrl+k
1-33. xsj_image
插入图片
默认快捷键 ctrl+g
1-34. xsj_olist
有序列表
默认快捷键 ctrl+o
1-35. xsj_ulist
无序列表
默认快捷键 ctrl+u
提供一个前置符参数,默认为 -
, 可以设定成 *
1-36. xsj_tlist
待办
提供一个前置符参数,默认为 -
, 可以设定成 *
1-37. xsj_fonticon
图标
1-38. xsj_table
表格
默认快捷键 ctrl+t
提供两个可选参数 row 和 column, 用于创建表格时,默认的行数及列数
1-39. xsj_ntable
表格组件
1-40. xsj_drawio
绘图组件
1-41. xsj_hr
水平线
默认快捷键 ctrl+r
1-42. xsj_undo
撤消上一步操作
默认快捷键 ctrl+z
1-43. xsj_redo
取消撤消
默认快捷键 ctrl+y
1-44. xsj_heading
标题
默认快捷键 ctrl+h
2. ace 编辑器命令
详细命令可以参考 ace 编辑器的 官网
3. codemirror 编辑器命令
详细命令可以参考 codemirror 的 官网
3-1. 小书匠扩展的 codemirror 命令
3-1-1. xsjFind
查找
默认快捷键 ctrl+f
3-1-2. xsjReplace
替换
默认快捷键 ctrl+f ctrl+f
4. 小书匠客户端命令
4-1. toggleWindow
隐藏或者显示小书匠客户端
4-2. hideWindow
隐藏小书匠客户端
4-3. showWindow
显示小书匠客户端
4-4. lockWindow
锁定小书匠客户端,并最小化到系统托盘
4-5. trayWindow
将小书匠客户端最小化到系统托盘
4-6. unTrayWindow
取消托盘状态