大家好,因應軟體開發,有時候會需要寫 wiki,說實在話,還真不是一件簡單的事情,也沒這麼多時間寫 wiki ,案子就做不完了,還要寫新功能的 wiki ,哪有那麼多時間?
 
開發新功能就沒時間了,還要寫 wiki ,實在真的沒時間。
 
所以通常的解決方案就是,我來說明功能,然後由理解的同事來寫。
這是最好的方式了。
 
那我們這邊就需要認識wiki 的專門語法 : Markdown ,從 維基百科 這邊可以知道,Markdown 語法主要目標是 "使用易讀易寫的純文字格式編寫文件,然後轉換成有效的XHTML(或者HTML)文件",這很重要,也就是說,在一般情況來說,Markdown 文案中並不會出現 XML 這種東西。
 
所以不能用 XML 來寫 XML 文案,就是需要一些特別規則了。
 
教學可以參考這邊:
 
那應該用什麼軟體編輯 Markdown 文案比較方便呢?那我推薦 MarkdownPad
 
下載網址:
 
 
安裝重點:
必須安裝 Awesomium 1.6.6 SDK.
 
安裝完後就可以來試試看囉。
 
例如:
 
## This is an H2 ##
 
就等於
 
<h2>This is an H2</h2>
 
有人可能會問: 這樣寫文件到底有什麼好處呢? 個人覺得格式統一與安全性是重點,因為用這樣去寫,也代表著HTML文件產生是受到限制的,所以 github 上面才能夠讓使用者上傳 Markdown 文件來做 wiki 。
 
缺點就是:
 
有些 Markdown 語法每一家系統支援不太一樣,例如: 反引號 來顯示程式碼,在比較舊的gitlab 版本就無法使用。然後如果不夠熟悉 Markdown 語法的話,寫起來可能會很悶。
 
總之,給大家參考囉。感恩。