編寫MarkDown(MD)文件的基本語法

2021-10-04 04:26:43 字數 2119 閱讀 8737

個人對md的觀點

基本語法

對html語法的支援

在使用github之前,我很少接觸markdown文件。在github隨處可見的readme.md就是md格式的檔案,我認為md語法比較人性化,用記事本就可以寫,但如果想即時預覽寫出的效果就要使用專業軟體了。這裡介紹一些常用的markdown語法。

markdown換行本身是沒有什麼特殊語法的,按回車就行了。但在github中這樣會讓多行的內容粘在一起,無法換行。只需要在每行的末尾打兩個空格再按回車就能正常顯示了。

在某一行的前面打上"#",該行就會變為標題行。如:

# 這是乙個標題

就會顯示:

注意,"#"和文字之間有乙個空格,其他語法也一樣

前面的#打得越多,標題就越小

# 一級標題

### **標題

在文字左右兩邊用「*」圍起來,被圍起來的部分就會顯示斜體。如:

其中*一部分會*顯示斜體

就會顯示:

其中一部分會顯示斜體

在文字左右兩邊用「**」圍起來,被圍起來的部分就會顯示斜體。如:

其中**一部分會**顯示粗體

就會顯示:

其中一部分會顯示粗體

那當然就是「***」了。輸入:

***斜體加粗***文字

顯示:斜體加粗文字

一行中輸入「---」(三個「-」)即可顯示分割線,就是這個:

在某一行前加「>」即可顯示引用,同樣要用空格隔開。

輸入:> 引用文字

顯示:

引用文字

這東西同樣也是能疊加的,如:

>>> 多級引用

使用「~~」將要劃刪除線的文字圍住。如:

~~刪除線~~測試

會顯示:

刪除線測試

這個相比其他的稍微複雜些,有乙個固定格式:

[顯示文字](鏈結 "說明文字")

[csdn](

會顯示:

csdn

![預設文字](鏈結 "說明文字")

![pic](

最終效果:

列表分專案列表和有序列表。專案列表沒有數字編號,在每行開頭寫「+」就可以,記得空格:

+ 標題1

+ 標題2

顯示:有序列表前面有數字編號,在每行開頭寫數字+「.」(如「1.」)即可。這個也要加空格!!!例子:

1. 標題1

2. 標題2

會顯示:

標題1標題2

+ 一級

+ 二級

這個應該是目前最麻煩的了:

|表頭1|表頭2|表頭3|

|-|-|-|

|11|12|13|

|21|22|23|

為了對齊均勻地加空格就好,最終顯示效果一樣的:

|表頭1|表頭2|表頭3|

|    -    |    -    |    -    |

|   11   |   12   |  13  |

|   21   |   22   |  23  |

顯示效果:

表頭1表頭2

表頭311

1213

2122

23使用「`」(不是單引號)圍住單行**。如:

`dim a as threading.thread`

會顯示:

dim a as threading.thread
多行**使用:

**片的格式,如:

dim a as threading.thread

a=new threading.thread(addressof run)

會顯示:

dim a as threading.thread

a=new threading.thread(addressof run)

markdown一般是在web端顯示,它是支援html語法的。這裡列舉一些簡單的例子。如上標記"n3"、下標記"n3"、縮寫概述"md"

編寫文件的思路

作為產品經理我們每天要寫的文件可是不少。除了brd mrd prd等我們要寫的正規文件。還包括一些其他無法起名,但我們每天還是要寫的文件。例如我最近在寫個需求概要文件。雖然是需求概要文件,但其實是乙個設計文件,要求產品經理在了解行業形態和公司產品特點的情況下,將公司產品與行業規則結合,創造乙個全新主...

介面文件的編寫

二 為什麼要寫介面文件?1 專案開發過程中前後端工程師有乙個統一的檔案進行溝通交流開發 2 專案維護中或者專案人員更迭,方便後期人員檢視 維護 三 介面規範是什麼?首先介面分為四部分 方法 uri 請求引數 返回引數 1 方法 新增 post 修改 put 刪除 delete 獲取 get 2 ur...

需求文件的編寫

需求的寫作形式一般分為兩種,物件導向和面向過程。對於不同的受眾和應用,採取不同的形式。面向過程的形式 主要的思想是ipo的原則,也就是 輸出 處理 輸出 文件格式,一 首先是對於整體系統的簡略介紹 目的,確定文件描述的物件和大體內容 二 系統上下文,介紹系統和其他系統之間的關係,邊界如何劃分 三 系...