<?xml version="1.0" encoding="UTF-8"?><rss xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom" version="2.0" xmlns:cc="http://cyber.law.harvard.edu/rss/creativeCommonsRssModule.html">
    <channel>
        <title><![CDATA[Stories by David Ye on Medium]]></title>
        <description><![CDATA[Stories by David Ye on Medium]]></description>
        <link>https://medium.com/@dwy6626?source=rss-2b59c87ccd8------2</link>
        <image>
            <url>https://cdn-images-1.medium.com/fit/c/150/150/0*Nke4LkpoKPZRWr-P</url>
            <title>Stories by David Ye on Medium</title>
            <link>https://medium.com/@dwy6626?source=rss-2b59c87ccd8------2</link>
        </image>
        <generator>Medium</generator>
        <lastBuildDate>Sun, 22 Nov 2026 15:11:43 GMT</lastBuildDate>
        <atom:link href="https://medium.com/@dwy6626/feed" rel="self" type="application/rss+xml"/>
        <webMaster><![CDATA[yourfriends@medium.com]]></webMaster>
        <atom:link href="http://medium.superfeedr.com/" rel="hub"/>
        <item>
            <title><![CDATA[為什麼我的 Markdown 會跑版？]]></title>
            <link>https://medium.com/@dwy6626/%E7%82%BA%E4%BB%80%E9%BA%BC%E6%88%91%E7%9A%84-markdown-%E6%9C%83%E8%B7%91%E7%89%88-5f0ea75a0a3b?source=rss-2b59c87ccd8------2</link>
            <guid isPermaLink="false">https://medium.com/p/5f0ea75a0a3b</guid>
            <category><![CDATA[markdown]]></category>
            <dc:creator><![CDATA[David Ye]]></dc:creator>
            <pubDate>Sun, 01 Sep 2019 12:24:51 GMT</pubDate>
            <atom:updated>2019-09-01T16:41:13.027Z</atom:updated>
            <content:encoded><![CDATA[<h3>Markdown 的發展史簡介</h3><p>轉自我的 Blog: <a href="https://dwy6626.github.io/post/markdown-intro-history/">https://dwy6626.github.io/post/markdown-intro-history/</a></p><p>這個問題困擾了我好一陣子，直到有朋友和我說，Markdown 有很多種標準，頓時茅塞頓開。既然程式語言有分版本，HTML 也有不同版本，那麼副檔名都是 .md 的 Markdown 也有很多種版本，似乎也是合理的事情。</p><p>那下一個問題就是：</p><blockquote>Markdown 有沒有一個<strong>統一</strong>的標準？</blockquote><p>答案是 <strong>沒有</strong> 的。</p><p>而且也不會有，因為 <strong>大家需要的 Markdown 可能不太一樣</strong> 。</p><p>最簡的例子就是換行，就標準的 Markdown 語法，當你在 .md 檔內換行，並不會真的換行。如果你要做到換行，必須在行尾加入兩個空白，或是手動插入 &lt;br&gt;。不過像是台灣知名的線上筆記服務 <a href="https://hackmd.io/">HackMD</a> ，就很貼心的配合了台灣人的打字習慣，幫你把每個換行都變成真正的換行。</p><p>不過包含 HackMD 在內，大部分的 Markdown 服務都有切換換行模式的選項，為了滿足每種人。也因此 Markdown 不會有真正統一的標準。</p><p>但是撇除這種選項式的差別之外，目前最知名的應該是 <a href="https://commonmark.org/">CommonMark</a> 了，若要問為什麼叫這個名字？跟一般的 Markdown 有什麼差別？就必須從 Markdown 的歷史說起。</p><h3>The Origin</h3><p>一切的開端，是 2004 時 <a href="https://daringfireball.net/projects/markdown/syntax">John Gruber 提出的 Markdown 標準</a> ，也是一般所說的經典的 Markdown，以 BSD 開源。</p><h3>提出的理念</h3><p>John Gruber 的文章寫道：</p><blockquote><em>The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions.</em></blockquote><p>簡單來說，就是想要創造一個易讀而且易寫的格式，也因此和 reStructuredText 一同被歸類為輕量級的標記語言（當然不只這兩種，可以參考 <a href="https://github.com/github/markup">GitHub 支援列表</a> ）。比起更早出現的 reStructuredText，Markdown 似乎又更簡單一些，雖然 Markdown 比起 reStructuredText 的功能較少，而且標準化也較晚，但並不影響 Markdown 受歡迎的程度。</p><p><a href="https://daringfireball.net/projects/markdown/syntax">John Gruber</a> 以 Perl 寫了第一個 Markdown to html 轉換器，一般被稱為 Markdown.pl ，但沒多久就沒有繼續維護了。而且隨著使用的人越來越多，漸漸有定義相關的問題產生出來，於是後來群雄並起，產生了各種分支。</p><p>原始 Markdown 的語法的中文翻譯可以看 <a href="https://markdown.tw/">這個網站</a>。或是 <a href="https://www.markdownguide.org/basic-syntax">Markdown Guide 這邊有個英文的對照表</a> 。</p><p>值得一提的是，這時候的 Markdown 的 Code Block 並不是大家熟悉的那種 ``` 開頭並且可以註記語言種類的 fenced code block：</p><pre>```javascript <br>console.log(&#39;Hello, markdown!&#39;) <br>```</pre><p>而是利用縮排的 indented code block，並不支援 syntax highlighting（因為不能註記語言種類）。注意前面有四個空格（或是一個 tab ）：</p><pre>console.log(&#39;Hello, markdown!&#39;)</pre><h3>Markdown Extra</h3><p><a href="http://six.pairlist.net/pipermail/markdown-discuss/2005-July/001379.html">2005 年由 Michel Fprtin 發表</a>，基於原始 Markdown 並修改及新增一些功能，並在當時希望這些能成為未來 Markdown 的標準（下面的 CommonMark 和 GFM 都分別和 Markdown Extra 有一些相同的特色），其中比較特別的除了表格之外也支援註解（Footnotes）和縮寫。官方編譯是 <a href="https://github.com/michelf/php-markdown">PHP Markdown</a> 。</p><p>因為不是這篇的重點，詳細介紹可以到 <a href="https://michelf.ca/projects/php-markdown/extra/">他們的網站</a> 。</p><h3>MultiMarkdown (MMD)</h3><p>就在 Markdown Extra 發表的隔天， <a href="http://six.pairlist.net/pipermail/markdown-discuss/2005-July/001389.html">Fletcher T. Penney 發表了 MultiMarkdown</a>，同樣也是基於原始 Markdown，希望能夠變得更接近像是 XHTML 或是 LaTeX 之類的排版語言，可以看 <a href="https://fletcherpenney.net/multimarkdown/">作者的介紹</a> ：</p><blockquote><em>It adds multiple syntax features (tables, footnotes, and citations, to name a few), in addition to the various output formats listed above (Markdown only creates HTML). Additionally, it builds in “smart” typography for various languages (proper left- and right-sided quotes, for example).</em></blockquote><p>一樣支援表格和註解等功能，但為了進一步進行更複雜的編寫，也支援引用、數學式、圖片說明等等功能。另外也支援更多的輸出格式，例如 PDF 和 OPML（一種開放式文件檔案格式，可以進一步讓 Microsoft Word 使用）。官方編譯器是原始的 Markdown.pl 的延伸，存放在 <a href="https://github.com/fletcher/MultiMarkdown">這個 repo</a> 。</p><h3>CommonMark</h3><p>因為原始 Markdown 就這樣缺乏後續的維護，因此就有人提出要接續幫 Markdown 進行語法的標準化以及規範的進一步維護，這就是 <a href="https://commonmark.org/">CommonMark</a> 的開端。從 2012 年開始，包括 Jeff Atwood（ <a href="https://stackoverflow.com/">Stack Overflow</a> 的共同創辦者之一） 在內的一群人啟動了所謂的 Markdown 標準化工作（ <a href="https://blog.codinghorror.com/the-future-of-markdown/">Standard Markdown</a>，這個專案原本的名字， <a href="https://blog.codinghorror.com/standard-markdown-is-now-common-markdown/">但是在原作者要求之下改名為 CommonMark</a> ，還為此叫他們換掉原本的 domain 並且不能直接重新導向到新網站）。</p><p>根據 Jeff Atwood （註：高中力學教的阿特午機的阿特午，英文也是 Atwood）的 <a href="https://blog.codinghorror.com/the-future-of-markdown/">blog 文章</a> ，這個計畫有以下的目標：</p><ul><li>定義<a href="https://spec.commonmark.org/current/">更明確的 spec</a>，把可能有爭議的語法全部定義清楚要怎麼轉換成 html（所以這個檔案超長）</li><li>新增一些選項，可以被關閉 / 開啟以符合各種需求，例如：</li><li>intra-word emphasis：字串內部的強調是否要用空格隔開</li><li>auto-hyperlink：是否自動為文章中的網址建立超連結</li><li>automatic return-based linebreaks：是否要把 return 視為換行</li><li><a href="https://github.com/commonmark/commonmark-spec">測試集</a>（和 spec 放在同一個 repo）</li><li>整理已知的變體（雖然 CommonMark 本身就是個變體）</li></ul><h3>因此和原始的 Markdown 有這些差別：</h3><p>新增項目（有許多並非 CommonMark 的創舉，而是很多已經在使用的 Markdown 已經先加入了）：</p><ul><li>所有 symbol 都可以被 backslash-escaped（中文叫跳脫字元，為了防止和保留字元混淆，因此在打某些特定符號的時候，例如 \ 的時候，必須要打成 \\。），因為他們發現一般人很難記得哪些字元要 escape XD</li><li>加入 backslash 換行機制（原本只能雙空白，很難在文字編輯器上面被注意到）</li><li>1) 也可以被當作數字列表（原本只能用 1.）</li><li>允許非 1 開始的數字列表</li><li>加入大家很常用的 Fenced code blocks：用 ``` 和 ~~~ 開頭</li></ul><p>更動：</p><ul><li>切換列表的符號會被判斷成新的 list（例如： -, +, * 以及 1., 1)）</li><li>不會把用空行分開的 &gt; 合併成一個 Quote</li><li>Link Syntax 改善：e.g. 單引號也可以被用在 Reference Link 的 Title 裡面（原本只有 Inline Link 可以，令人感到意味不明的區分）</li></ul><p>因為 CommonMark 旨在 <strong>建立一個嚴謹的標準，而不是支援更多的功能</strong> ，雖然上面有提到新增的語法，但是那些都是替代性語法，並不是真正的新功能。因此只要是原始 Markdown 沒有的功能， CommonMark 也不會有。</p><p>官方提供的編譯器有兩個，一個是 <a href="https://github.com/commonmark/cmark">cmark</a>，一個是 <a href="https://github.com/commonmark/commonmark.js">CommonMark.js</a> ，從名稱就能看出是基於什麼語言、或是給什麼語言用的了。</p><h3>GitHub Flavored Markdown (GFM)</h3><p>GFM，中文意思是「GitHub 偏好的 Markdown」， <a href="https://github.blog/2017-03-14-a-formal-spec-for-github-markdown/">2017 年發布</a> ，基於 CommonMark，再加上一些 GitHub 上可能會用到的功能，簡單來說，就是 GitHub 現在正在用的 Markdown（但其實在 GFM 之前的 2012 年，GitHub 就有支援 Markdown 了）。</p><h3>主要擴充：</h3><p><a href="https://github.github.com/gfm/">GFM</a> 的規範在此，這邊僅列出和 CommonMark 不同之處（其實它就是直接從 CommonMark 的 <a href="https://github.com/github/cmark-gfm">cmark 拉個分支出來</a>）</p><ul><li><a href="https://github.github.com/gfm/#tables-extension-">4.10 表格</a></li><li><a href="https://github.github.com/gfm/#task-list-items-extension-">5.3 任務列表</a>（主要給 issue 用的）</li><li><a href="https://github.github.com/gfm/#strikethrough-extension-">6.5 刪除線</a></li><li><a href="https://github.github.com/gfm/#autolinks-extension-">6.9 自動超連結的更改</a></li><li><a href="https://github.github.com/gfm/#disallowed-raw-html-extension-">6.11，過濾掉一些 HTML tag</a>，將裡面的 &lt; 取代成 &amp;lt;，似乎是 GitHub 認為這些標籤在編譯的時候在某些組合會有特殊情況發生。</li></ul><p><a href="https://github.github.com/gfm/">GFM</a> 的規範在此，這邊僅列出和 CommonMark 不同之處（其實它就是直接從 CommonMark 的 <a href="https://github.com/github/cmark-gfm">cmark 拉個分支出來</a> ）</p><h3>關於 HackMD</h3><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/0*tffDjJ0EZG2kGwN8.png" /></figure><p>在台灣寫一篇 Markdown 的文章，不能不提一下 <a href="https://hackmd.io/">HackMD</a> 。</p><p>HackMD 是基於 Markdown 之上（其實他們並沒有說清楚是基於哪種 Markdown 之上，不過你想的到的功能他們都有，甚至還能插入 YouTube 影片），加上一堆 Fancy 語法的台灣出產的線上筆記服務，只要打開瀏覽器就能使用，而且還能即時預覽！</p><p>有開源版本 <a href="https://demo.codimd.org/">CodiMD</a> ，也提供企業版的 SaaS （Software-as-a-Service），還能把版本歷史整合進 GitHub，讓大家愛上 Markdown 的好地方。</p><p>介紹的部分我就不多敘述，隨手 Google 兩篇看起來不錯的介紹：</p><ul><li><a href="https://www.playpcesor.com/2016/10/hackmd-hackpad-markdown.html">HackMD 取代 Hackpad 的中文版 Markdown 共筆平台上手教學</a></li><li><a href="https://medium.com/starrocket/hackmd-product-story-1e332f83d343">為工程師文件而生的協作平台：HackMD 開發故事</a></li></ul><p>個人認為在台灣的 Markdown 推廣，HackMD 一定會扮演一個重要的角色，因為真的太好用了。</p><h3>小結</h3><p>Markdown 有各種規範，也有各種選項可以調整，像是 <a href="http://dwy6626.github.io/">我的網站</a>是基於 Hugo，一個 Go 編寫的靜態網站生成器（SSG），所以採用了同樣是 Go 編寫的 <a href="https://github.com/russross/blackfriday">blackfriday</a> 來編譯。為了能夠方便寫作，我把可調選項（例如換行）調整成和 HackMD 的選項一樣，希望能夠最大化相容，並且最小化需要額外修改的地方。</p><p>寫了這麼多，希望大家在處理各種 .md 檔的時候，在享受 Markdown 帶來的便利（和潮感）之外，不要跟我一樣四處踩雷 QQ</p><h3>參考資料</h3><p>我在寫這篇的時候讀的文章，有些連結附在文章裡面了，就不再貼一次：</p><ul><li><a href="https://blog.othree.net/log/2017/03/27/github-flavored-markdown/">GitHub Flavored Markdown 標準規範</a></li><li><a href="https://www.jianshu.com/p/03dccaae11d7">关于 Markdown，你应该知道的</a></li><li><a href="https://www.veekxt.com/article/7">VeekXT</a></li><li><a href="https://www.markdownguide.org/extended-syntax">Extended Syntax</a></li><li><a href="http://aaronbeveridge.com/markdown/history.html">Markdown Movement</a></li></ul><p><em>Originally published at </em><a href="https://dwy6626.github.io/post/markdown-intro-history/"><em>https://dwy6626.github.io</em></a><em>.</em></p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=5f0ea75a0a3b" width="1" height="1" alt="">]]></content:encoded>
        </item>
    </channel>
</rss>