用markdown開始優雅的寫做

---

ebook:
title: Atom編寫markdown
authors: EdisonVan
---

前言

markdown能夠用來幹嗎？

• 項目需求分析
• 開發項目收穫記載
• 技術書籍閱讀筆記
• 給心愛的姑娘寫信
• 社交平臺寫做：GitHub、微信公衆號、知乎、博客園、語雀、掘金等衆多平臺支持markdown

學習markdown（記少不記多的原則）

獻上個人markdown筆記（相信我看着一個就足以應付平常使用了，整理於markdown官方文檔和我的實踐！）

推薦工具

推薦使用Atom，爲何不用VsCode？由於vscode裝太多插件可能致使各類快捷鍵衝突，因此強力推薦Atom專職書寫markdown!

目錄

• 章 1-Readme.md編寫規範
  
• 章 2-爲何選Atom
  • 插件下載
• 章 3-經常使用快捷鍵

單文件中章節跳轉寫法以下：

* [章 1-Readme.md編寫規範](#Readme.md編寫規範)
* [章 2-爲何選Atom](#爲何選Atom)
  * [插件下載](#插件下載)
* [章 3-經常使用快捷鍵](#經常使用快捷鍵)

Atom插件下載

高速下載方式1：

開啓全局代理，在Atom編輯器中點擊Preference-Install-搜索插件名進行下載

高速下載方式2：

在本身的Atom的packages文件夾中打開終端經過yarn命令行進行下載！
請看準本身的Atom的packages文件夾！

Step1.打開Atom插件官網，找到本身須要安裝的插件介紹頁面，點擊Versions到本身要下載的版本複製github連接

Step2.在Atom對應的packages文件夾下打開終端

Step3.如下載pretty-json爲例

• git clone pretty-json對應的git倉庫地址
• cd atom-Beautify （進入pretty-json插件所在文件夾）
• yarn/cnpm install (部署安裝插件的依賴庫，推薦使用yarn)
  
  Step4.最後重啓Atom，插件安裝完成

1.預覽插件markdown-preview-enhanced（預覽）[宇宙無敵最強]
功能簡介：能夠製做流程圖和幻燈片，以及拖動圖片上傳，拖動的圖片上傳的地址是https://i.imgur.com，不放心的就要常常作好備份了。本地留一個備份,寫完之後能夠直接導出成html，pdf，md文件，以及生成長圖，等等。

• 使用該插件前，請先禁用Atom自帶的markdown-preview插件（Enable點爲disabled便可）
  markdown-preview-enhanced功能詳細介紹

2.同步滾動(markdown-scroll-sync)

3.代碼加強(language-markdown)：代碼着色等基本功能，還提供了快捷的代碼片斷生成等功能 [請在settings中看快捷鍵]

4.圖片粘貼(markdown-image-paste)一步完成一堆重複操做：截圖－命名－保存－插入。 [須要配合千牛雲等工具搭建圖牀，自行拓展]
步驟1. 使用截圖工具將圖片複製到系統剪切板。
步驟2. 在Markdown新起一行輸入文件名。
步驟3. Ctrl + V 會自動把圖片保存到Markdown文件相同目錄下(所以要求Markdown文件應該先保存)，並命名爲剛輸入的文件名，同時在剛纔輸入文件名行處生成img標籤。

• 傳統插入圖片方式
  <img src="assets/Web.jpg" width=1200 height=1500>

5.git動圖插入插件

6.Atom Beautify
格式化代碼的插件

• settings
  使用方法參考
  格式化小程序

7.markdown-assistant [待完善]

要配合uploader使用
markdown快捷圖牀搭建

8.markdown-writer [待完善]

9.pretty-json（讓json變得更漂亮）
使用方式：一、選中一段json，只要選擇json的內容接口；二、使用快捷鍵 ctrl + shift + p，打開命令輸入框 輸入 pretty json prettify，按enter鍵便可看到格式化的效果；

10.markdown格式規範插件 [待查找]

11.Atom導出epub文件 [經過calibre 這個軟件]
Github參考教程
MyEbook Link :/usr/local/bin/ebook-convert

12.minimap
預覽所有代碼的一個插件，同時能方便的移動到指定的文件位置。

13.terminal-panel
用於執行命令並顯示輸出。打開終端面板快捷鍵：Ctrl + `

14.表格編輯(markdown-table-editor)
竅門：格子出來再輸入中文，每次中途切換爲中文輸入法，有時致使Tab鍵無效
使用:用Tab換一格,由於使用了language-markdown插件，因此這裏要用空格
用Enter換行
用ESC退出表格編輯
寫法：

| 插件 | 功能 |
| ------ | ---- |
| markdown-table-editor     |   寫表格唄   |

效果：
| 插件 | 功能 |
| ------ | ---- |
| markdown-table-editor | 寫表格唄 |

15.高亮插件
atom-wxml
16.文件路徑自動提示：autocomplete-paths
17.代碼快速生成：Emmet
18.open-in-browser / open-in-browsers
右鍵左側菜單讓html在瀏覽器中打開，不用再去文件裏雙擊啦~
19.javascript-snippets：
js片斷代碼自動補全，就像用emmet寫html同樣 查看示例
20.file-icons：
左側樹狀圖下，根據文件類型左側顯示不一樣圖標
21.docblockr
智能代碼註釋，讓註釋更有規範
22.git-plus
在 Atom 裏面執行 Git 命令，不用來回切換終端和編輯器
23.git-control
git面板

---

Atom編輯器書寫markdown注意事項

經常使用

• 自動保存：去擴展裏搜索autosave,而後點Settings勾上enabled
  Atom支持模糊查詢，輸入相關字母或者首字母便可

• 啓動自動換行
  勾選設置->Editor中的 Soft Wrap便可:
• 右側白線隱藏：
  way1.增大設置->Editor->Preferred Line Length的值
  way2.打開樣式表Atom-Stylesheet,而後在末尾添加以下幾行

atom-text-editor::shadow .wrap-guide {
//隱藏右邊的白線
visibility: hidden;
}

• 製做目錄分類管理筆記
  目錄.md

* [前言](doc/preface.md)
* [做用域與閉包](doc/scope.md)
* [this全面解析](doc/this.md)
* [對象](doc/Object.md)

doc/preface.md表示自動在目錄.md同級位置建立一個doc文件夾，doc文件夾中會包含preface.md文件！
doc文件夾下子文件預覽

Atom經常使用快捷鍵

快捷鍵	功能
cmd + shift + p	打開命令菜單
cmd + t	模糊搜索工做目錄下的文件
cmt + b	搜索已經打開的文件
ctrl + 0	焦點移動到文件目錄
cmd + \	隱藏左側目錄樹
ctrl + [	目錄中展開結點
ctrl + ]	目錄中縮起結點
d / a / m	對目錄選中的結點進行 刪除 / 添加 / 移動
cmd + f	搜索 當前文件
cmd + shift + f	搜索 目錄
cmd + shift + r	搜索 tag 前提是安裝ctags (brew install ctags)且生成tags (ctags -R src/)
alt + cmd + [	收起 所在代碼塊
alt + cmd + ]	展開 所在代碼塊
alt + cmd + shift + [	收起 當前全部代碼塊
alt + cmd + shift + ]	展開 當前全部代碼塊
cmd + ,	settings
cmd + k ... 方向鍵（上、下）	切分面板
cmd + w	關閉當前工做面板
alt + cmd + 左右	切換tab文件選項卡