用 Markdown 寫 doc
Table of contents
1 Markdown 簡介
Markdown（
.md）係一種純文字既檔案，對比起冇任何格式既純文字（.txt），Markdown 既格式標準畀我地用簡單符號去表達文字格式。GitHub 既
README.md 就係最佳例子。2 寫法
Markdown 既世界，任何兩個 components 之間都應該要隔至少一行。
2.1 一般文字
Code：
1呢一段係一般文字。呢一段係一般文字。呢一段係一般文字。 2呢一段係一般文字。呢一段係一般文字。呢一段係一般文字。 3呢一段係一般文字。呢一段係一般文字。呢一段係一般文字。 4呢一段係一般文字。呢一段係一般文字。呢一段係一般文字。 5呢一段係一般文字。呢一段係一般文字。呢一段係一般文字。 6 7開新段落要隔一行。開新段落要隔一行。開新段落要隔一行。 8開新段落要隔一行。開新段落要隔一行。開新段落要隔一行。 9開新段落要隔一行。開新段落要隔一行。開新段落要隔一行。 10開新段落要隔一行。開新段落要隔一行。開新段落要隔一行。 11開新段落要隔一行。開新段落要隔一行。開新段落要隔一行。
效果：
呢一段係一般文字。呢一段係一般文字。呢一段係一般文字。
呢一段係一般文字。呢一段係一般文字。呢一段係一般文字。
呢一段係一般文字。呢一段係一般文字。呢一段係一般文字。
呢一段係一般文字。呢一段係一般文字。呢一段係一般文字。
呢一段係一般文字。呢一段係一般文字。呢一段係一般文字。
開新段落要隔一行。開新段落要隔一行。開新段落要隔一行。
開新段落要隔一行。開新段落要隔一行。開新段落要隔一行。
開新段落要隔一行。開新段落要隔一行。開新段落要隔一行。
開新段落要隔一行。開新段落要隔一行。開新段落要隔一行。
開新段落要隔一行。開新段落要隔一行。開新段落要隔一行。
2.2 格式化文字
Code：
**粗體文字** _斜體文字_
效果：
粗體文字
斜體文字
2.3 標題
Code：
1# 1 H1 標題 2 3## 1.1 H2 標題 4 5### 1.1.1 H3 標題 6 7#### 1.1.1.1 H4 標題
2.4 分隔線
Code：
---
2.5 Code
Code：
This `code` is inline.
```js console.log("This is a code block."); ```
```java System.out.println("This is a code block."); ```
註：可以指明用邊隻語言做 syntax highlighting。
效果：
This
code is inline.console.log("This is a code block.");
System.out.println("This is a code block.");
2.6 引用
Code：
> Someone said, > > （可以有空行） > Something
效果：
Someone said,（可以有空行） Something
2.7 List
Code：
- Bullet point 1 - Inner - [x] Checklist item 1 (checked) - [ ] Checklist item 2 (unchecked)
1. 第一點 1. 數字會自動加上去 1. 顯示出黎就係 1、2、3
效果：
- Bullet point 1
- Inner
- Checklist item 1 (checked)
- Checklist item 2 (unchecked)
- 第一點
- 數字會自動加上去
- 顯示出黎就係 1、2、3
2.8 Table
Code：
| Table header - Column 1 | Table header - Column 2 | | ----------------------- | ----------------------- | | Record 1 - Column 1 | Record 1 - Column 2 | | Record 2 - Column 1 | Record 2 - Column 2 |
效果：
| Table header - Column 1 | Table header - Column 2 |
|---|---|
| Record 1 - Column 1 | Record 1 - Column 2 |
| Record 2 - Column 1 | Record 2 - Column 2 |
2.9 URL
Code：
[My e-Portfolio](https://blackr1234.github.io/eportfolio/#/)
效果：
2.10 圖片
Code：
效果：
2.11 HTML
部分 Markdown parser 支援 render HTML tags，甚或 CSS（
<style>）。3 推薦 IDE
要將 Markdown 檔裡面既格式顯示出黎，就需要可以睇得明 Markdown syntax 既檢視工具：
- Visual Studio Code 支援 Markdown 即時 preview
- 可以裝埋 Prettier 去自動 format
.md檔既內容
- 可以裝埋 Prettier 去自動 format
- Chrome 可以安裝 Markdown Viewer
- 設定 COMPILER 用 REMARK，開啟 gfm 模組
- 設定 CONTENT 開啟 autoreload、toc