標籤

Animate (1) Code (1) Music (1) 敗家 (1)

2016/06/29

輕量級標記語言 - Markdown, reStructuredText

    因為之前把專案放到原碼管控平台,想說除了附帶的 Wiki 或 ReadMe.md之外,是不是有更好的介紹說明文件方式,後來就找到的 ReadTheDocs 這個知名的平台,然後開始研究。
    一開始真的搞不懂為什麼 Doc還會需要什麼構建,不是把一堆文件放上去就好了嗎?而且除了 Markdown 之外,還有什麼 rst檔,那是什麼??


    後來就開始查資料,大概如下(以下資料來源出自於這邊)


Markdown

  • 使用最為廣泛也最簡單的輕量級標記語言。
  • 除了目前最有名的 GitHub 與 BitBucket 之外,還有StackOverflow 的語法基本上也是 Markdown 的強化版。
  • 另外目前一些 blog 也都支援 Markdown 語法,但是 Blogger 卻沒有.....。
  • Markdown 簡單卻又略顯不足,使得許多網站的應用必須增添額外的修改。


reStructuredText

  • 以 Python 寫成,主要也使用於 Python 社群中。
  • 是輕量級標記語言中最為完整的一套,不過真的是太複雜了,快要脫離「輕量級」的範圍了

然後,在 Readthedocs 中直接使用 md 的話,很簡單,就是依照檔名自動建立左邊的 Link,然後會把標題自動列在下面,如下圖:


但是最重要的search 功能卻無法使用

所以轉而研究把 md檔轉為 reStructuredText 的 rst檔,也只有一個專案有在座這個,別無分號:


然後研究之路還在進行中....也許結束之後就能在 LinkedIn中再加入這兩個語言專精了吧...

沒有留言:

張貼留言