Markdown 速查表
Agenda 并不是一款 markdown 编辑器,但它确实能识别部分 markdown 语法来应用样式。以下是可以使用的 markdown 快捷写法。
段落样式
以下样式会改变整个段落的外观。
标题
在行首使用 1 到 6 个井号,后跟一个空格。标题的级别由井号的数量决定。 例如 ### 示例 会生成三级标题。
短划线或项目符号列表
在行首输入项目符号、连字符、星号或加号,即可创建短划线列表项。 例如 • 示例项 1 - 示例项 2 * 示例项 3 + 示例项 4 会生成短划线或项目符号列表项。
编号列表
在行首输入一个数字,后跟句点和一个空格,即可创建编号列表项。 例如 \1. 示例项 1 会生成编号列表项。
如果想让编号列表从 1 以外的数字开始,直接使用该数字即可 例如 \3. 示例项 3 会生成一个从 3 开始的编号列表项。
清单列表
在行首输入一个连字符,后跟一个左方括号和一个右方括号。在两个方括号之间输入 “x” 则会创建一个已勾选的项目。 例如 - [ ] 示例 会生成一个清单列表项。
- [x] 示例 会生成一个已勾选的项目。
连字符是可选的,因此你也可以只用两个方括号来创建复选框。
预格式化
对于适合使用等宽字体呈现的内容(例如计算机代码),你可以应用预格式化样式。在行首输入三个反引号即可触发该样式。
例如
```sample 会生成 sample
代码
Agenda 支持计算机代码的语法着色。在三个反引号后面加上语言名称,即可指明该代码片段所使用的语言。
例如
```swift int i = 0; 会生成 int i = 0,并按 Swift 语言着色
所有受支持语言参数的完整列表由 highlight.js 项目维护,见 https://github.com/highlightjs/highlight.js/blob/main/SUPPORTED_LANGUAGES.md。
块引用
在行首使用一个或多个 > 符号,后跟一个空格。> 字符的数量决定引用的层级,并由文本前的竖线表示。
例如
> 示例 会生成
示例
行内样式
这些样式用于段落内部,以改变文本的外观。
斜体
用下划线或星号将文本括起来即可获得斜体样式。 例如 _sample_ 或 *sample* 会生成 sample
粗体
用双下划线或双星号将文本括起来即可获得粗体样式。 例如 __sample__ 或 **sample** 会生成 sample
删除线
用双波浪号将文本括起来即可获得删除线样式。
例如
~~sample~~ 会生成 sample
等宽(固定宽度)
对于某些内容(例如计算机源代码),使用固定宽度的文本会更合适。对于成块的文本,最好使用 预格式化 段落样式。对于行内文本,你可以用反引号将其括起来。
例如
`sample` 会生成 sample
高亮
用双等号或双冒号将文本括起来即可获得高亮样式。 例如 ==sample== 或 ::sample:: 会将 sample 一词高亮显示
插入
有些样式与文本的含义无关,而是用来标示诸如标签之类的信息元素。这些同样可以使用类似 markdown 的语法输入。
标签
要输入标签,只需使用 # 符号,后跟标签名称。标签中不能包含空格。
例如
输入 #giraffes 可创建一个名为 “giraffes” 的标签。
输入 # 会触发自动补全弹窗,帮助你找到所需的标签。
标签还可以在圆括号中包含参数。例如 #due(12/12/2018)。 要进一步了解如何充分利用标签中的参数,请参阅 标签、人物、文本操作与链接 一章。
人物标签
Agenda 还支持第二种专门用于个人(人物)的标签。你可以输入姓名或姓名缩写来指代某位朋友或同事。只需在文本前输入一个 @ 符号。
例如
输入 @Tom 可为名为 “Tom” 的人创建一个人物标签。
输入 @ 会触发自动补全弹窗,帮助你找到所需的人物。
表情符号
要输入表情符号,只需输入一个 :(冒号字符),后跟该表情符号的简称,再输入一个 : 结尾。
例如
输入 :+1: 可插入 👍 表情符号。
输入 : 会触发自动补全弹窗,帮助你找到所需的表情符号。
水平分隔线
如果你想用水平分隔线(一条横线)在视觉上划分笔记中的各个部分,可以连续输入三个短划线,后跟一个空格:
例如
输入 --- 可创建一条水平分隔线。
提示: 如果你正在导入一个 markdown 文件,可以用同样连续的三个短划线将其拆分成 Agenda 中一条条独立的笔记: 例如 第一条笔记
---第二条笔记这会创建两条不同的笔记,第一条的内容为“第一条笔记”,第二条的内容为“第二条笔记”。
表格
Agenda 让你可以在笔记中插入表格,只需在行首连续输入三个或更多竖线(|)符号即可快速创建:
例如
输入 ||| 可插入一个表格。
链接
文本中的链接会被自动识别,但你也可以用 markdown 语法添加链接。用方括号括住要显示的文本,后跟用圆括号括住的链接 URL。 例如 输入 [Agenda](agenda.com) 可为文本 “Agenda” 附加一个指向 agenda.com 的链接。
文本操作
虽然严格来说并不属于经典 markdown 语法,但 Agenda 允许你先输入一个反斜杠 \ 符号,后跟一个操作名称,来触发某些特定操作。
例如 \remind 会在你的笔记中插入一个提醒。操作还可以附带可选参数,例如 \remind(today at noon) 会将提醒安排在今天中午。其他常用操作包括 \now、\date 和 \time,用于插入当前日期和时间。
要全面了解所有操作,请参阅 文本操作速查表 一章。
操作也可以在模版中用作占位符,请参阅 创建和使用模版 一章。
阻止 markdown 解析
虽然 markdown 快捷写法既好用又快捷,但有时你可能并不希望某些内容被识别为 markdown。你可以先输入一个反斜杠 \ 字符,再输入原本要输入的内容,从而对上述 markdown 序列进行转义。按下空格键后,反斜杠字符会自动消失,文本则会保持你输入时的样子。例如,输入 \1. Something 不会生成编号列表,而会保留文本 1. Something。
请注意,在应用了 预格式化 段落样式和 等宽 行内样式的文本中,markdown 永远不会被解析。