寫出漂亮的Markdown文檔_v1.0.3

文檔撰寫教程_v1.0.3

作者：若布與宮合

Markdown印象

什麼是Markdown

• 用於編輯文檔，使用的語法是Markdown
• 編輯器千千萬，選擇合適自己的纔是正道
• 學習成本幾乎爲0
• 效果，列舉一二

複選框

• A
• B
• C

流程圖

流程圖實例

轉成PDF效果不錯

編輯器選擇

Typora

懶人首選，傻瓜式操作，安裝後即可編輯

下載地址 ， 有可能訪問不了

快捷鍵

Ctrl + / 切換到源代碼模式

Sublime 3

喜歡的“折騰”的可以玩玩這個

下載

下載地址 [Windows 64 bit](https://download.sublimetext.com/Sublime Text Build 3176 x64 Setup.exe)

實時預覽

• 請查看安裝方式。編輯前，請安裝Package Control、MarkdownPreview、MarkdownEditing、LiveReload以及AutoSave插件。安裝MarkdownPreview後，修改默認瀏覽器"browser": "Chrome",,解析器"enabled_parsers": ["markdown"],,"enable_autoreload": true,
• 開啓流程圖、高亮等
  https://www.zhihu.com/question/39372997?sort=created
• 在右下角選擇下拉條->Markdown（格式），ctrl+s保存爲docName.md,即可編寫
• 開始編輯，裝好插件後，在編輯框輸入內容，按組合快捷鍵ctrl+Shift+p,輸入：mp，選擇：

  Markdown Preview：Preview In Browser

  再點擊Markdown或者不點（僅配置了Markdown就不需要二次選擇），開始通過瀏覽器預覽文檔

IntelliJ IDEA

需要安裝預覽插件，可以試試

Editor.md

地址 http://pandao.github.io/editor.md/

CSDN md編輯器

地址 csdn-markdown編輯器
需要登錄，進入後，如果不能用markdown語法，請將博客設置改爲markdown
截稿前，發現無序列表有文字間隔bug

有道雲筆記

下載安裝使用。我發現的缺點是：不支持<ol>無序列表標籤。

Atom

進入官網下載

語法

• 標題

\#：一級標題
\##：二級標題
以此類推

• 圖片語法：

![圖片描述](圖片本地相對路徑或http url，如images/a.jpeg，or https://www.www.com/abc.jpeg)

• 目錄
  在頂部輸入[TOC]即可顯示目錄，下面介紹的插件可以將目錄顯示在左側
• 支持HTML
• 代碼語法
  半角符號包住代碼

// 代碼
// 三個反單引號 ```java（規定語言）
public class JMarkdown{
    
    private static final String name ;
    @Autowired
    private IService service ;
    
    public void method(){

    }
}
// 三個反單引號結尾 ```
// or
// ```xml
// ```

• 語法參考

數學

LaTeX

• 效果
  KaTeX parse error: Undefined control sequence: \bbox at position 2: \̲b̲b̲o̲x̲[5px,border:0px…

  $\begin{pmatrix} 1 & a_1 & a_1^2 & \cdots & a_1^n \\ 1 & a_2 & a_2^2 & \cdots & a_2^n \\ \vdots & \vdots & \vdots & \ddots & \vdots \\ 1 & a_m & a_m^2 & \cdots & a_m^n \\ \end{pmatrix}$

  $J(\theta) = \frac{1}{2m}\sum_{i = 0} ^m(y^i - h_\theta (x^i))^2$

• LaTeX語法請參考 http://www.mohu.org/info/symbols/symbols.htm

轉md格式爲html

使用Typora

使用Sublime

使用Markdown Preview 插件

【帶目錄】使用i5ting_ztree_toc

轉換命令 ztree_toc安裝命令見下文

上傳md文檔至Linux虛擬機，執行命令:

i5ting_ztree_toc -f docName.md
# or
i5ting_toc -f abc_kafka搭建_v1.0.md```
需要先安裝[i5ting_ztree_toc](#i5)服務

t.sh

使用腳本轉換

sh t.sh parentPath/docName.md

先準備t.sh腳本，t.sh腳本內容如下：

FILE_NAME=$1
NOTE_T="轉換"
NOTE_C=“完畢”
echo ${NOTE_T}${FILE_NAME}
i5ting_ztree_toc -f ${FILE_NAME}
echo ${NOTE_T}${NOTE_C}

轉換成功，打開docName.html，即可查看炫酷效果。

導入、導出功能

使用Typora

須安裝Pandoc

可導出各種格式的文檔

附錄

格式轉換

MS Office

Pandoc

• 安裝

# yum
yum -y install pandoc

• 命令

# 轉換成word
pandoc -f markdown -t docx file.md -o file.docx
# 效果很差

目錄工具 i5ting_ztree_toc

介紹

該插件可以將md文檔轉成html，自動生成序號，閱讀體驗也不錯。轉換命令見上文

Linux OS 環境

安裝nvm

先安裝nvm，即Node Version Manager(Node版本管理器)

curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.2/install.sh | bash

或者使用 wget

wget -qO- https://raw.githubusercontent.com/creationix/nvm/v0.33.2/install.sh | bash

注意觀察nvm的安裝目錄；該方法比較好用，但萬一https鏈接失效，可能就不能安裝了。
之後需要激活nvm：

source ~/.nvm/nvm.sh
# 或
export NVM_DIR="$HOME/.nvm"

安裝node

激活完成後，安裝node，命令：

nvm install node 

安裝完成後，切換到該版本，命令：

nvm use node

與此同時，npm已經默默安裝,可以放心的執行命令了。

安裝i5ting_ztree_toc

非常簡單，在全局安裝，命令：

npm install -g i5ting_toc

執行就可以了