Atom是github開發的開源跨平臺的編輯器,Atom的強大能夠與大名鼎鼎的Sublime Text相媲美。由於使用過Sublime Text,因此用Atom上手很快。這篇文章主要介紹使用Atom寫markdown。
以前在項目開發中都是使用.doc文件做爲接口文檔的載體,可是在使用中並不能很好的對比接口修改;若是使用.txt文件,有沒有醒目的格式。因此,最後咱們選擇語法簡單,方便對比的markdown來做爲接口文檔的載體。markdown的語法很少作介紹,主要介紹下書寫和解析markdown的編輯器。git
任何文本編輯器均可以書寫markdown,但咱們更指望可以在書寫的時候可以即時的看到解析效果,方便對格式進行調整。github
在mac os 下,我推薦Mou,界面簡潔優雅,解析流暢,也許沒有更好的了。json
Sublime Text:有markdown preview插件支持,可以在瀏覽器裏查看編譯效果,可是並非實時的,須要在修改後進行刷新或者,並不方便。
mardown pad:可以很好的書寫,並支持預覽。但free版居然不支持表格的解析!pro版能夠選擇解析的theme,如github等,是否可以解析表格不得而知。
Atom:推薦使用。內置對markdown的支持,可以方便的進行解析預覽。windows
一、打開任意.md文件(markdown源文件)
二、
windows : ctrl + shift + p
mac : command + shift + p
這條命令跟Sublime Text是同樣的,打開命令輸入框
三、輸入 markdown preview toggle
(能夠偷懶只輸入mdpt
,跟Sublime Text同樣支持模糊匹配)
四、按enter鍵便可看到預覽,如圖,左邊編輯,右邊實時預覽。瀏覽器
其實,markdown preview是Atom的一個插件,查看步驟以下:
一、
windows : ctrl + shift + p
mac : command + shift + p
打開命令輸入框,輸入 settings view view installed packages
二、在篩選輸入框中,寫markdown
,便可看到。服務器
下面我再介紹一個小插件,用來格式化從服務端請求來的json數據,pretty json
。
操做步驟:
一、
mac : ctrl + shift + p
windows : command + shift + p
打開命令輸入框 settings view install packages and themes
(也能夠簡單的輸入install package
)markdown
二、在搜索框輸入pretty json
,點擊Packages按鈕,在搜索結果中,點擊Install
按鈕便可安裝。編輯器
圖中是我已經安裝後的樣子。
三、選中一段從服務器下載的json,如工具
{"result":{"error":0,"type":2000},"sync":{"newdata":null,"lastver":"0","newnum":"0"}}
四、
windows : ctrl + shift + p
mac : command + shift + p
打開命令輸入框 輸入 pretty json prettify
atom
五、點擊肯定,便可
Atom有更多的插件可使咱們的工做更加便捷,咱們應該善於利用工具提升效率。
原文連接:http://www.jianshu.com/p/ad3e737e5dc2