Markdown 任務列表
1. 前言
To-do 任務列表是一種很常見的時間管理工具,它適用于工作計劃、個人生活以及家庭學習。使用 Markdown 語法我們也可以實現一個基本的 To-do 任務列表。
Markdown 的 To-Do List 的內容是由無序列表,復選框,圖標幾種功能的組合。
環境說明:
考慮到 Markdown 工具之間的不兼容,有的內容直接從頁面復制粘貼到本地不會正常顯示,大家學習時自己動手寫是肯定沒問題的。本節所有實例代碼及演示效果均使用 Typora 工具完成。
本節所有截圖均為 Typora 導出 Html 后效果。
2. 語法詳解
在 Markdown 文件中,在 " 無序列表 -,+,*
" 后面使用 「中括號 []」
聲明復選框。在中括號中寫入 x
,便可實現選中效果。
實例 1:
#### 復選框 checkbox
- [ ] Java
- [x] Php
或者
#### 復選框 checkbox
+ [ ] Java
+ [x] Php
或者
#### 復選框 checkbox
* [ ] Java
* [x] Php
這三種語法渲染后的結果相同,渲染結果如下:
其轉換后的 html 的內容如下:
<ul>
<li class="task-list-item"><input type="checkbox" disabled=""> Java</li>
<li class="task-list-item"><input type="checkbox" disabled="" checked=""> Php</li>
</ul>
3. 使用場景及應用實例
To-Do List 可以用于工作計劃、學習管理等。非常適合小型協作團隊,用來制定任務計劃、分配任務執行人、跟蹤任務完成情況等。
實例 2:
做一個團隊協作的任務列表。
-
第一步:規劃任務、責任人
做一個學生管理系統為主題的課程設計,有四個主要參與者,小甲負責前端,小乙負責后端開發,小丙負責數據庫,小丁測試和編寫文檔。因此整個任務也相應的分為了四個部分:前端、后端、數據庫和統籌。
此時代碼如下:
#### 學生管理系統
- [ ] 數據庫設計 責任人: 小丙
- [ ] 服務端開發 責任人: 小乙
- [ ] 前端開發 責任人: 小甲
- [ ] 系統測試 責任人: 小丁
- [ ] 文檔編寫 責任人: 小丁
-
第二步:補充任務詳情、完成時間
有了大致任務分工和責任人,此時需要每個責任人對自己的模塊做補充,并預估完成時間。
這一步代碼如下 (片段):
#### 學生管理系統(二)
- [ ] **數據庫設計**
責任人:小丙
任務描述:搭建 Mysql 數據庫環境;設計數據表;數據庫設計滿足三范式。
預計完成時間 5 天
-
第三步:責任人分解任務
將任務分解為一件件可完成的工作,并輸出為任務列表。
這一步代碼如下(片段)
#### 學生管理系統(三)
- [ ] **數據庫設計**
責任人:小丙
任務描述:搭建 Mysql 數據庫環境;設計數據表;數據庫設計滿足三范式。
預計完成時間 5 天
- [ ] 搭建數據庫環境
- [ ] 整理數據表名、主要字段
- [ ] 設計 E-R 圖
- [ ] 使數據表符合范式要求
- [ ] 應用到數據庫中
- [ ] 整理此部分文檔筆記
-
第四步:隨時更新任務狀態
根據進展情況更新任務的狀態,即在中括號中用
x
替換 “空格”。這一步代碼如下(片段)
#### 學生管理系統(四)
- [ ] **數據庫設計**
責任人:小丙
任務描述:搭建 Mysql 數據庫環境;設計數據表;數據庫設計滿足三范式。
預計完成時間 5 天
- [x] 搭建數據庫環境
- [x] 整理數據表名、主要字段
- [x] 設計 E-R 圖
- [x] 使數據表符合范式要求
- [ ] 應用到數據庫中
- [ ] 整理此部分文檔筆記
最后,我們可以看到完成的成果如下:
4. 小結
- 復選框只有跟在 “無序列表” 之后才能顯示;
- 復選框語法
中括號 []
之間只能是空格
或者x
,其他情況下,不會渲染成復選框標簽。
當我們用 Markdown 撰寫自己的文檔時,可以首先用 “任務列表” 的方式在文章的開頭將整篇文章的寫作安排寫好,這樣當我們寫作篇幅較長時,這一習慣將會非常有利于思路的整理和延續。