最好用的離線markdown編輯器Haroopad介紹

目錄

• 最好用的離線markdown編輯器Haroopad介紹
  • Basic usage
  • Code Block
  • Image
  • Table
  • Tasklist
  • Math
  • Diagram
  • Presentation mode
  • Other features
  • Extra
  • Summary

最好用的離線markdown編輯器Haroopad介紹

常常寫技術文檔，須要將文檔像代碼同樣管理，例如能夠提交SVN或者GIT，能夠比對歷史差別。用WORD之類的工具，文檔不是純文本，無法知足需求。用簡單文本沒有格式不美觀。Latex最強大，可是對於通常文檔撰寫又過重量，配置一個好的模板太費神，並且標記有些複雜很差記。

若是你也有上述困苦，那麼能夠嘗試一下markdown！ Markdown是一種可使用普通文本編輯器編寫的標記語言，相似HTML，不過比HTML簡單不少！ 用markdown撰寫的文章能夠直接轉成HTML格式進行顯示。 目前主流的博客系統都直接支持markdown，開源代碼託管網站GitHub中readme文檔撰寫默認是markdown格式。 Mardown語法很是簡單, 基本十分鐘能夠所有學會！

爲了讓markdown支持更豐富的元素，不一樣組織和我的還開發了許多markdown擴展，例如能夠支持表格、編程語言代碼塊、數學公式等等。

雖然markdown能夠用任何文本編輯器進行撰寫，可是使用專門的markdown編輯器，能夠作到一邊編寫一邊實時顯示渲染效果。網上免費的markdown編輯器很是多，這裏給你們介紹一款我的以爲最好用的markdown編輯器Haroopad！ 它是開源、免費、跨平臺的，支持windows，linux和mac系統。Haroopad已經內置了各類markdown擴展，支持100多種編程語言代碼的直接顯示，例如C/C++， JAVA， C#， Ruby， Python， Erlang， Makefile等等，甚至代碼顯示的背景框都有不少主題能夠選擇。另外它支持撰寫數學公式，支持一套文本繪圖DSL，支持自動生成文檔目錄等等。Haroopad支持直接將文檔發佈成PDF格式。最後Haroopad支持用戶自定義顯示樣式。 因爲Haroopad是韓國人寫的，因此用戶手冊裏面不少都是韓語，所以這裏將Haroopad的一些主要用法給你們介紹一下！

Basic usage

Haroopad使用很是簡單，左邊是編輯區，右邊是預覽區。支持實時預覽。

Haroopad支持全部的markdown標準語法。Markdown基本語法見http://www.appinn.com/markdown/，基本上十分鐘以內能夠所有學會。

寫好的markdown文稿保存成*.md文件。md文件是純文本格式，能夠用記事本打開直接閱讀修改。在Haroopad下，能夠將md文稿發佈成帶樣式的html文件或者pdf文件。

發佈成HTML格式: 文件 -> 導出到 -> HTML

發佈成PDF格式： 文件 -> 打印 -> 打印到文件

Code Block

對於程序員來講，最須要的就是對於Code Block的強大支持！ Haroopad支持100多種編程語言！每種語言的代碼會按照語言風格進行編排縮進和語法高亮。

Code Block須要以~~~加上編程語言標識符的單獨一行開始，以~~~單獨一行結束。

例如對於一段C++的Code Block。

顯示結果以下：

代碼塊的背景框風格在Haroopad中能夠配置：

文件 -> 偏好設置 -> Code -> 主題

Haroopad支持很是多的代碼框風格，例如上面C++中的例子中配置的是sublime的風格。

Image

在Haroopad中插入圖片很是方便，以下：

小括號內分別是圖片的url（能夠是網絡地址）、title以及圖片的顯示大小（單位px）。

Table

Haroopad中繪製表格的語法以下：

顯示效果以下：

Tasklist

Haroopad擴展支持tasklist，語法以下：

顯示效果以下：

Math

Haroopad藉助Mathjax擴展來支持對數學公式的顯示。

爲了讓haroopad支持數學公式首先須要在配置裏面開啓數學公式支持：

文件 -> 偏好設置 -> Markdown -> 啓用數學表達式

md文檔中數學公式框須要以單獨$$一行開始，並以$$一行結束，中間是符合Mathjax要求的數學公式：

顯示效果：

Diagram

Haroopad支持mermaid擴展。Mermaid是一套繪圖的符號語言擴展，支持繪製各類關係圖，序列圖。

Haroopad中mermaid繪圖以~~~mermaid單獨一行開始，以~~~單獨一行結束。

顯示效果以下：

其中graph TD指定繪圖方向是從上而下，改成graph LR則是從左至右。

其它例子：

Mermaid擴展還支持其它繪圖方式，以及調整繪圖樣式，具體見mermail介紹https://github.com/knsv/mermaid/wiki

Presentation mode

Haroopad支持直接撰寫PPT。在撰寫文檔的時候以***作分頁，在presentation mode下就會是獨立的一頁PPT。

要將文檔以PPT模式顯示，須要開啓presentation mode：

視圖 -> Presentation Mode

具體參見Haroopad關於Presentation Mode的說明: http://pad.haroopress.com/page.html?f=how-to-write-presentation

Other features

• Haroopad支持對markdown語法的快捷鍵和自動補全。須要的話能夠在偏好設置裏面進行設置。

• Haroopad支持自動插入目錄。具體在須要插入目錄的地方插入空行和 `` 就搞定一切了。

• Haroopad支持豐富的媒體插入。例如音頻和視頻。

• Haroopad支持自定義編輯區和預覽發佈的樣式，具體在

  文件 -> 偏好設置 -> 編輯器 ->自定義主題 -> 編輯
  文件 -> 偏好設置 -> 預覽 ->自定義主題 -> 編輯

  在彈出的目錄裏面有css文件，修改該css文件用來改變樣式。每次修改css後須要重啓haroopad。我收集了不少適合haroopad使用的css主題，能夠在個人github上下載：https://github.com/MagicBowen/markdown

Extra

將md文件發佈成pdf後，會發現Code Block背景框的風格變化了。該問題的解決須要配置haroopad的預覽樣式css文件，增長設置讓其嚴格按照顏色樣式打印就行了。以下：

Summary

因爲其簡單易用，Markdown在社區已經愈來愈流行。甚至有些項目將自動化測試用例都用markdown語法來寫，能夠直接發佈給客戶看成說明文檔，執行的時候靠一段解釋代碼將其翻譯成目標語言執行，真的作到測試即文檔。而Haroopad是一款很是強大的markdown編輯器，它內置的不少mardown擴展都是爲了方便程序員，避免了你們處處尋找插件自行配製的繁瑣。到目前爲止haroopad是我找到的最好用的markdown編輯器。最後在支持如此多的特性後，haroopad依然很是輕量！ 但願Haroopad一樣適合你！

做者：MagicBowen ， Email: e.bowen.wang@icloud.com ， 轉載請註明做者信息！