使用 Markdown 寫文件、寫書、做筆記

Markdown格式是什麼?

Markdown logo 看過.md檔嗎? 那就是Markdown的縮寫。一句話來說，「Markdown用精簡的語法寫文件」。

語法是？ 最終可產生 html 標籤的網頁語法 文件是？ 如 Github.com 讀我 README.md 程式敘述文件

有點混搭的概念，就是「想表達的內容（純文字）」＋「精簡的符號語法」，編譯之後變成「網頁內容」。你也可以用word來寫文件，但是相對來說就複雜許多，程式設計師要酷就是要學Markdown。

Markdown運用範圍很廣，可以拿來做什麼？

  • 程式的文件 - 告訴其他程式設計師你的程式的架構長怎樣，怎麼接著開發你的程式或是使用它
  • 筆記 - 用txt檔覺得太簡陋，但是word有時候又很麻煩，那就用Markdown作筆記看看
  • 書 - 既然寫成筆記了，再加把勁的話說不定可以寫成書喔!
  • 部落格 - Markdown可以轉成HTML，所以是可以放在網頁上，沒問題的
  • 想寫什麼就寫什麼，重點是它不排版就很美了啊!

Markdown教學

開啟你的編輯器來寫寫看

打開你的VS Code建立一個README.md檔案，然後開始寫一些Markdown語法，接著看一下畫面右上角有一個按鈕如下。點下去之後，就會跳出一個預覽視窗，這個時候你就可以邊寫邊看到實際的呈現結果。

或是可以試試看用HackMd線上Markdown編輯器玩玩看，按這裡來見建立一份新Markdown文件。HackMd可以同時多人協作一份MarkDown文件。

課堂練習

  • 照著Markdown臨摹範本寫一份一模一樣格式的Markdown文件看看，寫在markdown101.md中，最後可以在README.md中填寫lesson5資料夾的簡介與一些上課筆記。

有看過README.md嗎?

README 仔細一看會發現其實就是read me，也就是「讀我」的意思，通常放在文件的根目錄，裡面寫著就是這份文件的使用方法的資訊。想想看別人如果下載你的專案，他一開始鐵定手足無措，如果有一個說明書鐵定是再好不過了！

其實README.md沒有固定的格式，但是重點就是你要讓別人知道你的專案是什麼，他該如何使用你的專案。這裡有人建議的README.md版型 版型1 版型2

來看看其他人的README.md是怎麼寫的

另外還有人會寫contributing.md(也可以直接寫在README.md)，告訴其他人如何對github上的專案貢獻自己的建議或是修改程式碼(範例)

使用GitBook來寫本書吧!

如果用 Markdown 能輕鬆撰寫一本電子書的話，那該有多好啊！那就來試試看GitBook吧!

大致上的用法就跟一般Markdown相差無幾，但是要注意裡面的README.md與SUMMARY.md兩個檔案，這裡的README.md是這本Gitbook的簡介，SUMMARY.md是目錄，如果你觀察力夠敏銳，你其實早就發現這份教材其實也是用GitBook製作的。

參考資料

回家練習

  • 替自己的Github上的專案建立README.md檔，寫一些介紹或是使用教學讓別人更了解你的專案

  • 建立一本Gitbook，把這堂課的上課筆記整理進去，或是有自己想寫的主題也可以

results matching ""

    No results matching ""