最好用的離線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以及圖片的顯示大?。▎挝籶x)。

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支持自動插入目錄。具體在需要插入目錄的地方插入空行和 [toc] 就搞定一切了。

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

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

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

    在彈出的目錄里面有css文件,修改該css文件用來改變樣式。每次修改css后需要重啟haroopad。

Extra

將md文件發布成pdf后,會發現Code Block背景框的風格變化了。該問題的解決需要配置haroopad的預覽樣式css文件,設置嚴格按照顏色樣式打印就好了。如下:

Summary

由于其簡單易用,Markdown在社區已經越來越流行。甚至有些項目將自動化測試用例都用markdown語法來寫,可以直接發布給客戶當作說明文檔,執行的時候靠一段解釋代碼將其翻譯成目標語言執行,真的做到測試即文檔。而Haroopad是一款非常強大的markdown編輯器,它內置的很多mardown擴展都是為了方便程序員,避免了大家到處尋找插件自行配制的繁瑣。到目前為止haroopad是我找到的最好用的markdown編輯器,這篇文檔就是用haroopad撰寫。最后在支持如此多的特性后,haroopad依然非常輕量! 希望Haroopad同樣適合你!

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,818評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,185評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事?!?“怎么了?”我有些...
    開封第一講書人閱讀 175,656評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,647評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,446評論 6 405
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,951評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,041評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,189評論 0 287
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,718評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,602評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,800評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,316評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,045評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,419評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,671評論 1 281
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,420評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,755評論 2 371

推薦閱讀更多精彩內容