歡迎使用社群 Markdown 編輯器寫文章!
使用社群 Markdown 編輯器撰寫技術文章,只專注於內容和技術,不再費心排版的問題。這是一份簡要的 Markdown 引導指南,希望可以幫助您順利的開始使用 Markdown 編輯器。
一. 全屏模式
兩個視窗:
請點選此處退出全屏模式:
現在請按照下圖指示點選進入全屏狀態:
二. 豐富的快捷鍵
本 Markdown 編輯器支援豐富的格式快捷鍵,可以非常便捷、輕鬆的使用 Markdown 語言,形成優美的排版和內容格式。
支援的快捷鍵有:
- 加粗:
Ctrl/Cmd + B
- 標題:
Ctrl/Cmd + H
- 插入連結:
Ctrl/Cmd + K
- 插入程式碼:
Ctrl/Cmd + Alt/Option + C
- 行內程式碼:
Ctrl/Cmd + Alt/Option + C
- 插入圖片:
Ctrl/Cmd + Alt/Option + I
- 無序列表:
Ctrl/Cmd + Alt/Option + L
- 撤銷:
Ctrl/Cmd + Z
- 剪下:
Ctrl/Cmd + X
三. 常用語法
1. 標題
語法格式:'#'+'空格'+'文字'
# 一級標題
## 二級標題
### 三級標題
#### 四級標題
##### 五級標題
###### 六級標題
圖例:
注:
#
和標題之間建議保留一個字元的空格,這是最標準的 Markdown 寫法;- 一般情況下,文章的標題會被系統渲染為『一級標題』,所以請避免在文章內容中使用『一級標題』。
- 請善用二級和三級標題,LearnKu 文章模組會自動為您生成 TOC,這會讓文章結構更加清晰,如下:
2. 列表
列表格式也很常用,在 Markdown 中,你只需要在文字前面加上 -
就可以了,例如:
- 文字一
- 文字二
- 文字三
如果你希望有序列表,也可以在文字前面加上 1.
2.
3.
就可以了,例如:
1. 文字一
2. 文字二
3. 文字三
圖例:
3. 連結和圖片
在 Markdown 中插入連結需要使用 [顯示文字](連結地址)
這樣的格式語法。例如:
[LearnKu 開發者社群](https://learnku.com)
在 Markdown 中,插入圖片不需要其他按鈕,你只需要使用 ![](圖片連結地址)
這樣的語法即可,例如:
![](https://cdn.learnku.com/uploads/images/201806/12/1/Owic58YjaW.jpeg?imageView2/2/w/1240/h/0)
注:插入圖片的語法和連結的語法很像,只是前面多了一個
!
。
圖例:
LearnKu 上圖片顯示時會加陰影,如果你想去除陰影的話,可以使用以下方式:
<img src="https://cdn.learnku.com/uploads/images/201806/12/1/Owic58YjaW.jpeg" class="rm-style">
圖例:
注:LearnKu 編輯器上傳圖片,只需要將圖片拖拽丟入『編輯視窗』內,或者複製圖片在『編輯視窗』內黏貼即可上傳。
4. 引用
寫作時經常需要引用他人的文字,在 Markdown 中,你只需要在你希望引用的文字前面加上 >
即可,例如:
Markdown 是一種輕量級標記語言,它允許人們使用易讀易寫的純文字格式編寫文件,然後轉換成格式豐富的 HTML 頁面。
圖例:
5. 行內程式碼
行內的程式碼使用 `
包起來即可,一般在描述類、函式、檔名稱及路徑時使用,如:
Laravel 框架的所有配置檔案都儲存在 `config` 目錄中。可以使用 `config()` 輔助函式來讀取。
圖例:
6. 程式碼高亮
如下是程式碼段的語法:
```程式語言 這是程式碼段 ```
例如:
```php class Order extends Model { ... public function scopeDelivered($query) { return $query->where('status', 'delivered'); } public function scopePaid($query) { return $query->where('paid', true); } } $orders = Order::delivered()->paid()->get(); ```
圖例:
注:在 LearnKu 上,每一個社群都設定了預設的程式碼高亮語法,例如 PHP 和 Laravel 社群預設使用
php
作為預設高亮語法,當你只使用```
而未設定語法時,此功能會被用上。
7. 粗體和斜體
Markdown 的粗體和斜體非常簡單,用兩個 *
包含一段文字就是粗體的語法,用一個 *
包含一段文字就是斜體的語法。例如:
Markdown 的 **粗體** 和 *斜體* 非常簡單。
最終顯示的就是下文:
Markdown 的 粗體 和 斜體 非常簡單。
圖例:
8. 表格
基礎的表格語法:
專案 | 價格
-------- | ---
iPhone | $560
iPad | $780
iMac | $1000
可以使用冒號來定義對齊方式:
| 專案 | 價格 | 數量 |
| :-------- | --------:| :--: |
| iPhone | 6000 元 | 5 |
| iPad | 3800 元 | 12 |
| iMac | 10000 元 | 234 |
圖例:
結語
Markdown 編寫是開發者的必備技能,尤其在撰寫技術文件上,更加離不開 Markdown 語法。如果對 Markdown 語法不熟悉,本篇文章羅列了使用頻率最高的 8 個語法,你可以多看幾遍,或者開啟 編輯器 直接嘗試,這樣會記得更加牢固。
在掌握了以上的簡單語法後,推薦自行搜尋查閱『完整 Markdown 語法』。