2019-01-10markdown(.md)的書寫語法

git中常用md來書寫接口文檔。為此。。。

phpstorm編輯器下markdown的插件?

setting->Plugins->Browse repositories->markdown Navigator

關(guān)于樣式錯誤問題。

colors & Fonts->scheme name->Darcula

語法

一、標題

在想要設(shè)置為標題的文字前面加#來表示

一個#是一級標題,二個#是二級標題,以此類推。支持六級標題。

注:標準語法一般在#后跟個空格再寫文字,貌似簡書不加空格也行。

示例:

# 這是一級標題## 這是二級標題### 這是三級標題#### 這是四級標題##### 這是五級標題###### 這是六級標題

效果如下:

這是一級標題

這是二級標題

這是三級標題

這是四級標題

這是五級標題

這是六級標題

二、字體

加粗

要加粗的文字左右分別用兩個*號包起來

斜體

要傾斜的文字左右分別用一個*號包起來

斜體加粗

要傾斜和加粗的文字左右分別用三個*號包起來

刪除線

要加刪除線的文字左右分別用兩個~~號包起來

示例:

**這是加粗的文字**

*這是傾斜的文字*`

***這是斜體加粗的文字***

~~這是加刪除線的文字~~

效果如下:

這是加粗的文字

這是傾斜的文字

這是斜體加粗的文字

這是加刪除線的文字

三、引用

在引用的文字前加>即可。引用也可以嵌套,如加兩個>>三個>>>

n個...

貌似可以一直加下去,但沒神馬卵用

示例:

>這是引用的內(nèi)容>>這是引用的內(nèi)容>>>>>>>>>>這是引用的內(nèi)容

效果如下:

這是引用的內(nèi)容

這是引用的內(nèi)容

這是引用的內(nèi)容

四、分割線

三個或者三個以上的 - 或者 * 都可以。

示例:

---

----

***

*****

效果如下:

可以看到,顯示效果是一樣的。

五、圖片

語法:

![圖片alt](圖片地址''圖片title'')圖片alt就是顯示在圖片下面的文字,相當于對圖片內(nèi)容的解釋。圖片title是圖片的標題,當鼠標移到圖片上時顯示的內(nèi)容。title可加可不加

示例:

![blockchain](https://ss0.bdstatic.com/70cFvHSh_Q1YnxGkpoWK1HF6hhy/it/u=702257389,1274025419&fm=27&gp=0.jpg"區(qū)塊鏈")

效果如下:

blockchain

上傳本地圖片直接點擊導(dǎo)航欄的圖片標志,選擇圖片即可

六、超鏈接

語法:

[超鏈接名](超鏈接地址"超鏈接title")title可加可不加

示例:

[簡書](http://jianshu.com)[百度](http://baidu.com)

效果如下:

簡書

百度

注:Markdown本身語法不支持鏈接在新頁面中打開,貌似簡書做了處理,是可以的。別的平臺可能就不行了,如果想要在新頁面中打開的話可以用html語言的a標簽代替。

超鏈接名示例簡書

七、列表

無序列表

語法:

無序列表用 - + * 任何一種都可以

- 列表內(nèi)容

+ 列表內(nèi)容

* 列表內(nèi)容

注意:- + * 跟內(nèi)容之間都要有一個空格

效果如下:

列表內(nèi)容

列表內(nèi)容

列表內(nèi)容

有序列表

語法:

數(shù)字加點

1.列表內(nèi)容

2.列表內(nèi)容

3.列表內(nèi)容

注意:序號跟內(nèi)容之間要有空格

效果如下:

1.列表內(nèi)容

2.列表內(nèi)容

3.列表內(nèi)容

列表嵌套

上一級和下一級之間敲三個空格即可

一級無序列表內(nèi)容

二級無序列表內(nèi)容

二級無序列表內(nèi)容

二級無序列表內(nèi)容

一級無序列表內(nèi)容

二級有序列表內(nèi)容

二級有序列表內(nèi)容

二級有序列表內(nèi)容

一級有序列表內(nèi)容

二級無序列表內(nèi)容

二級無序列表內(nèi)容

二級無序列表內(nèi)容

一級有序列表內(nèi)容

二級有序列表內(nèi)容

二級有序列表內(nèi)容

二級有序列表內(nèi)容

八、表格

語法:

表頭|表頭|表頭---|:--:|---:內(nèi)容|內(nèi)容|內(nèi)容內(nèi)容|內(nèi)容|內(nèi)容第二行分割表頭和內(nèi)容。- 有一個就行,為了對齊,多加了幾個文字默認居左-兩邊加:表示文字居中-右邊加:表示文字居右注:原生的語法兩邊都要用| 包起來。此處省略

示例:

姓名|技能|排行--|:--:|--:劉備|哭|大哥關(guān)羽|打|二哥張飛|罵|三弟

效果如下:

姓名技能排行

劉備哭大哥

關(guān)羽打二哥

張飛罵三弟

九、代碼

語法:

單行代碼:代碼之間分別用一個反引號包起來

`代碼內(nèi)容`

代碼塊:代碼之間分別用三個反引號包起來,且兩邊的反引號單獨占一行

(```)

? 代碼...

? 代碼...

? 代碼...

(```)

注:為了防止轉(zhuǎn)譯,前后三個反引號處加了小括號,實際是沒有的。這里只是用來演示,實際中去掉兩邊小括號即可。

示例:

單行代碼

`create database hero;`

代碼塊

(```)functionfun(){echo"這是一句非常牛逼的代碼";? ? }? ? fun();(```)

效果如下:

單行代碼

create database hero;

代碼塊

functionfun(){echo"這是一句非常牛逼的代碼";}fun();

十、流程圖

```flowst=>start: 開始op=>operation: My Operationcond=>condition: YesorNo?e=>endst->op->condcond(yes)->econd(no)->op&```

效果如下:

簡書不支持流程圖,所以截了個圖

流程圖.png

作者:高鴻祥

鏈接:http://www.itdecent.cn/p/191d1e21f7ed

來源:簡書

簡書著作權(quán)歸作者所有,任何形式的轉(zhuǎn)載都請聯(lián)系作者獲得授權(quán)并注明出處。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容