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; 會產生以 Swift 語言上色的 int i = 0
所有支援的語言參數完整列表由 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 語法加入。用方括號包住要顯示的文字,後面接以圓括號包住的連結網址。 例如 輸入 [Agenda](agenda.com) 會建立一個連到 agenda.com 的連結,附加在「Agenda」這段文字上。
文字動作
雖然嚴格來說並不屬於傳統 Markdown 語法的一部分,但 Agenda 允許你先輸入一個反斜線 \ 符號,後接一個動作,來觸發某些動作。
舉例來說, \remind 會觸發在你的筆記中插入提醒事項。動作也可以附帶選用參數,例如 \remind(today at noon) 會為今天中午排定一則提醒事項。其他常見的動作包括 \now、\date 和 \time,用來插入目前的日期和時間。
如需所有動作的完整總覽,請參閱 文字動作速查表 一章。
動作也可以在範本中作為佔位符使用,請參閱 建立與使用範本 一章。
防止 Markdown 被解析
雖然 Markdown 快速輸入方式既好用又快速,但有時你可能不希望某些內容被辨識為 Markdown。你可以先輸入一個反斜線 \ 字元,再輸入你原本要打的內容,來跳脫上述的 Markdown 序列。在你按下空格鍵後,反斜線字元應該會自動消失,而文字則會維持你輸入的樣子。舉例來說,輸入 \1. Something 不會產生編號列表,而是文字 1. Something。
請注意,在套用了 Preformatted 段落樣式和 Fixed Width 行內樣式的文字中,Markdown 絕不會被解析。