主頁 > 知識庫 > 一文了解文檔寫作利器 Markdown

一文了解文檔寫作利器 Markdown

熱門標(biāo)簽:地圖標(biāo)注資源分享注冊 襄陽外呼增值業(yè)務(wù)線路解決方案 慶陽外呼系統(tǒng)定制開發(fā) 怎么去掉地圖標(biāo)注文字 北京外呼系統(tǒng)咨詢電話 高德地圖標(biāo)注公司位置需要錢嗎 廊坊地圖標(biāo)注申請入口 海南人工外呼系統(tǒng)哪家好 合肥阿里辦理400電話號

一、前言

無論你是軟件開發(fā)者,還是互聯(lián)網(wǎng)寫作者,為了使自己寫的文檔或作品更好的流通,便于在不同場合、不同環(huán)境、不同人群的查看,亟需尋求一種通用、便于扭轉(zhuǎn)、留存的文檔格式。

在這之前、現(xiàn)在或者今后,你可能會存在以下這些困擾:

  • 作為軟件開發(fā)者、架構(gòu)師,寫的設(shè)計(jì)文檔到底應(yīng)該以什么樣的格式來保存呢?是word、txt、pdf,還是html呢?這些文檔格式,在不同情況下,可能都會存在。有時(shí)為了便于評審、修改,會采用word格式;有時(shí)為了防止文檔篡改,會采用pdf格式;有時(shí)為了便于網(wǎng)頁瀏覽(如:GitLib),會采用html格式。難道要針對不同格式進(jìn)行不同的編寫嗎?
  • 作為互聯(lián)網(wǎng)寫作者,寫的文章希望能夠在不同的平臺能夠發(fā)表,分享給更多的人。而在不同互聯(lián)網(wǎng)平臺,如:微信公眾號、CSND、知乎、有道云筆記等,文章的排版會花費(fèi)你大量的時(shí)間,不同平臺排版上也會存在一些差異性,甚至讓你抓狂。難道不同平臺要進(jìn)行不同排版的調(diào)整嗎?

辦法總比困難多! 上述的這些困擾,Markdown就能很好的解決,接下來我們一起來了解下它吧。

二、Markdown是什么

Markdown是一種可以使用普通文本編輯器編寫的標(biāo)記語言,通過簡單的標(biāo)記語法,它可以使普通文本內(nèi)容具有一定的格式。

Markdown具有一系列衍生版本,用于擴(kuò)展Markdown的功能(如表格、腳注、內(nèi)嵌HTML等等),這些功能原初的Markdown尚不具備,它們能讓Markdown轉(zhuǎn)換成更多的格式,例如LaTeX,Docbook。Markdown增強(qiáng)版中比較有名的有Markdown Extra、MultiMarkdown、 Maruku等。這些衍生版本要么基于工具,如Pandoc;要么基于網(wǎng)站,如GitHub和Wikipedia,在語法上基本兼容,但在一些語法和渲染效果上有改動。

Markdown也是最受歡迎的寫作"標(biāo)記語言",它的簡潔語法代替了排版,而不像一般我們用的字處理軟件Word有大量的排版、字體設(shè)置等。它使我們更專心于碼字,用"標(biāo)記"語法,來替代常見的排版格式。

目前,支持Markdown語法的編輯器、平臺、工具有很多,如:CSDN、簡書、GitLab等,有的還支持了Markdown的導(dǎo)入、常見格式的導(dǎo)出,都十分的方便、高效。

優(yōu)點(diǎn)

  • 專注你的文字內(nèi)容而不是排版樣式,安心寫作。
  • 輕松的導(dǎo)出 HTML、PDF 和本身的 .md 文件。
  • 純文本內(nèi)容,兼容所有的文本編輯器與字處理軟件。
  • 隨時(shí)修改你的文章版本,不必像字處理軟件生成若干文件版本導(dǎo)致混亂。
  • 可讀、直觀、學(xué)習(xí)成本低。

誤區(qū)

We believe that writing is about content, about what you want to say – not about fancy formatting.

我們堅(jiān)信寫作寫的是內(nèi)容,所思所想,而不是花樣格式。

Markdown旨在簡潔、高效,也由于Markdown的易讀易寫,人們用不同的編程語言實(shí)現(xiàn)了多個(gè)版本的解析器和生成器,這就導(dǎo)致了目前不同的Markdown工具集成了不同的功能(基礎(chǔ)功能大致相同),例如流程圖與時(shí)序圖,復(fù)雜表格與復(fù)雜公式的呈現(xiàn),雖然功能的豐富并沒有什么本質(zhì)的缺點(diǎn),但終歸有些背離初衷,何況在編寫的過程中很費(fèi)神,不如使用專業(yè)的工具撰寫來的更有效率,所以如果你需實(shí)現(xiàn)復(fù)雜功能,專業(yè)的圖形界面工具會更加方便。當(dāng)然,如果你對折騰這些不同客戶端對 Markdown 的定制所帶來高階功能感到愉悅的話,那也是無可厚非的。

三、Markdown語法

下面介紹的是最常用的Markdown語法,包括語法說明、效果展示。其中,同一種類效果可能會有多種寫法,第一種為標(biāo)準(zhǔn)語法,不同Markdown編輯器,會支持不同的特殊語法,并且展示效果上有細(xì)微差異。

1、標(biāo)題

使用#標(biāo)簽表示標(biāo)題,#和標(biāo)題之間必須有空格。一級標(biāo)題使用一個(gè)#,二級標(biāo)題使用兩個(gè)##,以此類推,共有六級標(biāo)題。

語法如下:

# 標(biāo)題H1
## 標(biāo)題H2
### 標(biāo)題H3
#### 標(biāo)題H4
##### 標(biāo)題H5
###### 標(biāo)題H6

效果如下:

2、字符效果

  • 刪除線:使用~~刪除線~~或s>刪除線/s>標(biāo)簽
  • 斜體字:使用*斜體字*或_斜體字_標(biāo)簽
  • 粗體字:使用**粗體字**或__粗體字__標(biāo)簽
  • 上標(biāo):使用Osup>2/sup>標(biāo)簽
  • 下標(biāo):使用Xsub>2/sub>標(biāo)簽
  • 縮寫:使用HTML中的abbr標(biāo)簽,如:HTML

語法如下:

~~刪除線1~~ s>刪除線2/s> 
*斜體字1* _斜體字2_ 
**粗體字1** __粗體字2__ 
Xsub>2/sub> 
Osup>2/sup> 
The abbr title="Hyper Text Markup Language">HTML/abbr> specification is maintained by the abbr title="World Wide Web Consortium">W3C/abbr>.

效果如下:

3、引用

使用>標(biāo)簽表示引用,>>標(biāo)簽表示引用里面再套一層引用,依次類推。

語法如下:

>這是一級引用文本內(nèi)容 
>>這是二級引用文本內(nèi)容 
>>>這是三級引用文本內(nèi)容

效果如下:

4、代碼高亮

代碼塊:

使用3個(gè)連續(xù)的` 標(biāo)簽包圍起來。

語法如下:


效果如下:

行內(nèi)代碼:

使用``標(biāo)簽表示行內(nèi)代碼。

語法如下:

執(zhí)行命令:`npm install marked`

效果如下:

5、鏈接

使用[](link)標(biāo)簽表示鏈接。其中,[]內(nèi)的內(nèi)容為要添加鏈接的文字,link為鏈接地址。

語法如下:

[普通鏈接](https://blog.csdn.net/xcbeyond) 
[普通鏈接帶標(biāo)題](https://blog.csdn.net/xcbeyond "普通鏈接帶標(biāo)題") 
直接鏈接:https://blog.csdn.net/xcbeyond

效果如下:

6、圖片

使用![Alt text](/path/to/img.jpg)標(biāo)簽導(dǎo)入圖片。其中,Alt text為如果圖片無法顯示時(shí)顯示的文字,/path/to/img.jpg為圖片所在路徑。

語法如下:

![](https://www.mdeditor.com/images/logos/markdown.png)

效果如下:

7、列表

列表分為有序列表、無序列表,如下:

  • 有序列表:使用1. 2. 3.標(biāo)簽表示,其中.后面有一個(gè)空格的。
  • 無序列表:使用*-+標(biāo)簽表示。

有序列表:

語法如下:

1. 第一行
2. 第二行
3. 第三行

效果如下:


無序列表:

語法如下:

+ 列表一
+ 列表二
  + 列表二-1
  + 列表二-2
  + 列表二-3
* 列表三
  * 列表三-1
  * 列表三-2
  * 列表三-3

效果如下:

8、分割線

使用---***或者* * *標(biāo)簽表示水平分割線,其中大于三個(gè)。

語法如下:

---
***
* * *

效果如下:

9、表格

語法如下:

| Heading | Heading | Heading |
| ------- | ------- | ------- |
|  Cell |  Cell |  Cell |
|  Cell |  Cell |  Cell |

| Heading | Heading | Heading |
| :----- | :----: | ------: |
| 左對齊 | 居中 | 右對齊 |
| 左對齊 | 居中 | 右對齊 |

效果如下:

10、流程圖

流程圖常用的有一般流程圖、序列圖,不同Markdown編輯器,語法也是不同的。如下分別說明了其中一種寫法,其他寫法可自行具體查閱相關(guān)資料。

(注:個(gè)別編輯器可能無法正常顯示效果。)

流程圖:

語法如下:

效果如下:

序列圖:

語法如下:


效果如下:

四、Markdown常用編輯器及工具

如何更好的使用Markdown,工具必不可少,在此介紹我用過的幾款工具,分享給大家,以滿足不同使用場景。

對于工具而言,只要自己用著順手,就是最好的

1、Typora

Typora是一款輕便簡潔的Markdown編輯器,支持即時(shí)渲染技術(shù),這也是與其他Markdown編輯器最顯著的區(qū)別。即時(shí)渲染使得你寫Markdown就想是寫Word文檔一樣流暢自如,不像其他編輯器的有編輯欄和顯示欄。并且支持多種主題以供選擇,如:GitHub、Newsprint等,如下圖所示。

官方地址:https://www.typora.io/

2、MarkdownPad2

MarkdownPad2是一個(gè)windows上的Markdown編輯器,需下載安裝,便于離線使用,如下圖所示。

官方地址:http://markdownpad.com/

3、Mou

Mou是Mac上的Markdown編輯器,兩欄界面,直觀清爽,功能簡潔到位,而且免費(fèi),如小圖所示。

不僅如此,Mou還有一些有趣的偏好設(shè)置(Preference),例如主題(Themes)與樣式(CSS),它們可以配置出定制化的文本編輯效果與導(dǎo)出效果,如果你對自帶的主題與樣式不滿意還可以到 GitHub上搜索其它愛好者為Mou編寫的更多主題樣式,導(dǎo)入的方式可以在偏好設(shè)置的Themes或CSS選項(xiàng)中選擇reload。

官方地址:http://25.io/mou/

4、MdEditor

mdeditor是一個(gè)在線編輯markdown的工具,無需本地安裝,在線隨時(shí)編輯、直接預(yù)覽、隨時(shí)導(dǎo)出,還提供對應(yīng)標(biāo)簽的圖標(biāo)快捷操作,如下圖所示。

在線編輯完后,可導(dǎo)出保存到本地.md文件即可。

官方地址:https://www.mdeditor.com/

5、coolaf md

我姑且就叫它為coolaf md,它是一款在線Markdown編輯、各種格式導(dǎo)出的工具,支持導(dǎo)出Word、HTML、PDF格式的文檔,非常好用,強(qiáng)烈推薦使用,如下圖所示。

官方地址:http://coolaf.com/tool/md

6、Md2All

Md2All是一款在線Markdown編輯,方便復(fù)制粘貼,一鍵排版,自定義CSS,80多種代碼高亮,所有的樣式渲染非常完美,包括圖片加字也有方案支持。無需作任何調(diào)整就能一鍵復(fù)制到微信公眾號、博客園、掘金、知乎、csdn、51cto等平臺,如下圖所示。

官方地址:http://md.aclickall.com/

參考文章:

https://zhuanlan.zhihu.com/p/92312642https://www.jianshu.com/p/1e402922ee32http://markdownpad.com/http://25.io/mou/

到此這篇關(guān)于一文了解文檔寫作利器 Markdown 的文章就介紹到這了,更多相關(guān)Markdown 寫作利器內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!

您可能感興趣的文章:
  • markdown簡介和語法介紹
  • Markdown語法備忘
  • 如何使用Gitblog和Markdown建自己的博客
  • CommonMark 使用教程:將 Markdown 語法轉(zhuǎn)成 Html

標(biāo)簽:臺州 商丘 鎮(zhèn)江 綿陽 鶴崗 平頂山 株洲 哈密

巨人網(wǎng)絡(luò)通訊聲明:本文標(biāo)題《一文了解文檔寫作利器 Markdown》,本文關(guān)鍵詞  一文,了解,文檔,寫作,利器,;如發(fā)現(xiàn)本文內(nèi)容存在版權(quán)問題,煩請?zhí)峁┫嚓P(guān)信息告之我們,我們將及時(shí)溝通與處理。本站內(nèi)容系統(tǒng)采集于網(wǎng)絡(luò),涉及言論、版權(quán)與本站無關(guān)。
  • 相關(guān)文章
  • 下面列出與本文章《一文了解文檔寫作利器 Markdown》相關(guān)的同類信息!
  • 本頁收集關(guān)于一文了解文檔寫作利器 Markdown的相關(guān)信息資訊供網(wǎng)民參考!
  • 推薦文章