使用入门

欢迎使用 OneMark。OneMark 为 OneNote 带来 markdown 语法支持,并融入现代编辑器的先进设计。本文将介绍如何开始使用。

实时预览

当你在 OneNote 中输入一段 Markdown 文本后,按一下Enter,OneMark 将自动帮你转换为富格式的文本。例如,你可以试试输入# 测试标题,然后按回车, 见证奇迹的时刻。

Markdown 语法支持

OneMark 采用 GitHub 偏好的 Markdown 语法,除了基础的标题、列表、引用,还支持任务列表、代码块、LaTeX、toc等高级语法。如果你对 Markdown 还不太了解,可以阅读完整的语法说明。这里我们介绍一些重要的语法和注意事项。

块状元素

引用、代码块以及 LaTeX 在 OneMark 中都是以块状元素(Block elements)的方式支持的。输入语法前缀,按一下 Enter,就会创建一个带背景色的编辑区域。

1
2
3
>    #引用
``` #代码块
$$ #LaTeX

然后就可以正常输入内容了。按Enter会在元素内创建新行,并自动触发引用内的渲染,或者代码块中的语法高亮。按 Ctrl + Enter 会跳出当前编辑区域,并触发最后一行的渲染。

表格

Markdown 标准中的表格语法由于受限于纯文本格式,使用起来既不方便也不直观。然而 OneNote 中已经拥有一套完整的表格功能设计。你可以通过菜单栏的插入命令新建,或者在一段文字之后按 Tab 来创建表格。当你使用Tab创建一个新的单元格时,OneMark 会自动渲染上一个单元格的内容,类似于普通文本里按Enter

你也可以从其他 markdown 编辑器中复制完整的表格语法,粘贴到 OneNote,然后按F5渲染。

源码模式

OneMark 将 markdown 原文隐藏存储在每一行文本中。按Ctrl + ,使当前行进入源码模式,你可以做一些修改,然后再按Ctrl + ,重新渲染。

你也可以不必依赖源码模式,直接在文本上进行各种编辑操作。当需要导出 markdown 或者进入源码模式时,OneMark 会自动识别做出的修改,并更新相应的 markdown 原文。所以,你可以在任意 OneNote 客户端查看并修改笔记,不需要安装 OneMark。我们称之为“双向编辑”。

与 OneNote 共舞

在最初设计 OneMark 时,我们希望它尽可能无缝融入到 OneNote 中,贴合已有的用户体验,引入现代编辑器的先进技术和设计理念,而不是创建一个独立的 markdown 视图。实时渲染以及双向编辑的应用,让我们的想法得以实现。

OneNote 本身有一些非常好的交互设计,特别是关于列表和表格的部分。你可以用快键键轻松创建并操作它们,有时候比 markdown 的纯文本方便很多。例如:

要明白,markdown 只是快速创建格式化内容的一种选择而已,完成之后你可以用任意方式进行编辑。利用好 OneNote 本身的操作特性,再配合 OneMark,你可以找到属于自己的最佳工作体验。

导入/导出 markdown

OneMark 支持导入其他编辑器创建的 markdown 文件,包括引用的本地图片。你也可以直接粘贴 markdown 源码到 OneNote,按 F5 渲染。

如果想导出 OneNote 笔记为 markdown 格式,按F8会自动转换并复制到剪切板。你也可以点击菜单栏中的导出 markdown命令保存为本地文件,笔记内嵌入的图片会随文件一起导出。

其他

如果有其他疑问或反馈,请联系 onemark@neux.studio

祝你使用愉快!