天天看點

Markdown 文法知多少?

大家好,我是堅果,我的公衆号是“堅果前端”

今天是2021年11月4日星期四,

農曆九月三十。

寫作本文的目的是為了更好的與悟空做一比較

閱讀本文,你可以打開 ​​線上 Markdown 編輯器 ​​。這樣,你就可以一邊學習 Markdown 文法一邊練習了。熟悉 Markdown 之後,再選擇一個順手的 Markdown 的應用程式。

Markdown 是一種輕量級标記語言,它允許人們使用易讀易寫的純文字格式編寫文檔,Markdown檔案的字尾名便是“.md”。

​Markdown 語言在 2004 由約翰·格魯伯(英語:John Gruber)建立。

Markdown 編寫的文檔可以導出 HTML 、Word、圖像、PDF、Epub 等多種格式的文檔。

Markdown 編寫的文檔字尾為 .md, .markdown。

專注于文字内容;

純文字,易讀易寫,可以友善地納入版本控制;

文法簡單,沒有什麼學習成本,能輕松在碼字的同時做出美觀大方的排版。

Markdown 能被使用來撰寫電子書,如:Gitbook。

目前許多網站都廣泛使用 Markdown 來撰寫幫助文檔或是用于論壇上發表消息。例如:GitHub、碼雲,掘金,51CTO部落格,簡書、雲+社群。華為雲社群,StackOverflow、GitBook、有道雲筆記、等等

還可以在一下場景使用

網站(hugo,hexo,wordpress,)

檔案資料

筆記

書籍

示範文稿

郵件

文檔

這是我推薦的一些Markdown文檔創作工具:

現代編輯器

VSCode

傳統編輯器

Vim / Emacs / Sublime Text / Notepad++

IDE 自帶編輯器

IntelliJ IDEA / Android Studio / WebStorm

專用編輯器

Ulysses / Mou / Typora / Markpad

 ​​線上 Markdown 編輯器 ​​

Typora 官網:​​https://typora.io/​​

Mweb官網:​​https://zh.mweb.im/​​

這是一級标題

這是六級标題

在Markdown裡面添加标題,你要在文本的前面添加一個井号 (​<code>​#​</code>​​)。 你可以鍵入多個井号來生成你想要的幾級标題。 例如,一級标題你需要添加一個井号 (​<code>​# 一級标題​</code>​​), 當你需要一個三級标題時你就要三個井号 (​<code>​### 三級标題​</code>​).

Markdown 清單

Markdown 支援有序清單和無序清單。

無序清單使用星号(*)、加号(+)或是減号(-)作為清單标記,這些标記後面要添加一個空格,然後再填寫内容:

​有序清單使用數字并加上 . 号來表示,如:

如果是段落上的一個函數或片段的代碼可以用反引号把它包起來(`),例如:

代碼區塊使用 4 個空格或者一個制表符(Tab 鍵)。

你也可以用 ``` 包裹一段代碼,并指定一種語言(也可以不指定):

在 Markdown 中有兩種不同的連結種類,但是它們的渲染方式完全相同。

第一種連結格式叫做 内聯連結。建立一個内聯的連結, 你需要将被連結的文本用方括号 ( ​<code>​[ ]​</code>​ )包裹起來, 然後将連結位址用圓括号 ( ​<code>​( )​</code>​ )包裹起來。 *這些括号及以後出現的括号均為英文半角符号,譯者注。 比方說,建立一個寫着 "堅果的51部落格" 到 ​​​​https://blog.51cto.com/jianguo​​​​ 的超連結, 你應該使用Markdown這樣書寫: ​<code>​[堅果的51部落格](​​https://blog.51cto.com/jianguo​​)​</code>​.

另外一種連結叫做 全局 連結。顧名思義,這個連結連結到文檔的另外一個位置。這裡有一個示例來說明我們想表達什麼:

​我們可以通過變量來設定一個連結,變量指派在文檔末尾進行:

第一種圖檔的格式叫做 内聯圖檔連結。建立一個内聯的圖檔連結, 需要輸入一個感歎号 ( ​<code>​!​</code>​​ )将方括号 ( ​<code>​[ ]​</code>​​ )中的描述性文本包裹起來, 然後使用圓括号 ( ​<code>​( )​</code>​ )包裹連結位址。 (描述性文本是為視障者解釋圖檔短語或者句子的語句。)

例如,建立一個描述文本為"jianguo"的内聯的連結位址為 jianguo 的圖檔, 你應該這樣寫Markdown: 

​​​

Markdown 文法知多少?

​​

當然,你也可以像網址那樣對圖檔網址使用變量:

Markdown 還沒有辦法指定圖檔的高度與寬度,如果你需要的話,你可以使用普通的 &lt;img&gt; 标簽。

Markdown 制作表格使用 | 來分隔不同的單元格,使用 - 來分隔表頭和其他行。

文法格式如下:

<col>

表頭

單元格

對齊方式

我們可以設定表格的對齊方式:

-: 設定内容和标題欄居右對齊。

:- 設定内容和标題欄居左對齊。

:-: 設定内容和标題欄居中對齊。

左對齊

右對齊

居中對齊

在Markdown讓一些文本 斜體 ,你可以使用下劃線 (​<code>​_​</code>​ ) 包裹文本。 例如, ​<code>​_這個_​</code>​ 詞将會變成 斜體。

同理,在Markdown中将一些文本加粗, 你可以使用兩個星号包裹文本 ( )。這将**真的** 會吸引你的注意。

當然,你可以在同一行中使用 ​<code>​_斜體和粗體_​</code>​。你也可以 ​<code>​**跨越 多個 詞語**​</code>​.

不在 Markdown 涵蓋範圍之内的标簽,都可以直接在文檔裡面用 HTML 撰寫。

目前支援的 HTML 元素有:​<code>​&lt;kbd&gt; &lt;b&gt; &lt;i&gt; &lt;em&gt; &lt;sup&gt; &lt;sub&gt; &lt;br&gt;​</code>​等 ,如:

Markdown 文法知多少?
Markdown 文法知多少?

網上有很多資源用來學習 Markdown。以下列出一些:

​​Markdown Tutorial​​. 一個開源網站,你能用浏覽器在這個網站上嘗試 Markdown。

​​Typesetting Markdown​​​. 這是一個系列教程,介紹了使用 ​​pandoc​​​ 和 ​​ConTeXt​​ 對 Markdown 文檔進行排版的系統。

目前由于悟空不支援甘特圖,流程圖等。是以在這兒不友善展示。

希望悟空早日上線這個功能!

後面也會出一期如何使用wukong寫作的部落格。

下面是我的公衆号,歡迎大家掃碼關注。

Markdown 文法知多少?

繼續閱讀