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