2019-01-10markdown(.md)的书写语法

git中常用md来书写接口文档。为此。。。

phpstorm编辑器下markdown的插件 

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

关于样式错误问题。

colors & Fonts->scheme name->Darcula

语法

一、标题

在想要设置为标题的文字前面加#来表示

一个#是一级标题,二个#是二级标题,以此类推。支持六级标题。

注:标准语法一般在#后跟个空格再写文字,貌似简书不加空格也行。

示例:

# 这是一级标题## 这是二级标题### 这是三级标题#### 这是四级标题##### 这是五级标题###### 这是六级标题

效果如下:

这是一级标题

这是二级标题

这是三级标题

这是四级标题

这是五级标题

这是六级标题

二、字体

加粗

要加粗的文字左右分别用两个*号包起来

斜体

要倾斜的文字左右分别用一个*号包起来

斜体加粗

要倾斜和加粗的文字左右分别用三个*号包起来

删除线

要加删除线的文字左右分别用两个~~号包起来

示例:

**这是加粗的文字**

*这是倾斜的文字*`

***这是斜体加粗的文字***

~~这是加删除线的文字~~

效果如下:

这是加粗的文字

这是倾斜的文字

这是斜体加粗的文字

这是加删除线的文字

三、引用

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

n个...

貌似可以一直加下去,但没神马卵用

示例:

>这是引用的内容>>这是引用的内容>>>>>>>>>>这是引用的内容

效果如下:

这是引用的内容

这是引用的内容

这是引用的内容

四、分割线

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

示例:

---

----

***

*****

效果如下:

可以看到,显示效果是一样的。

五、图片

语法:

![图片alt](图片地址''图片title'')图片alt就是显示在图片下面的文字,相当于对图片内容的解释。图片title是图片的标题,当鼠标移到图片上时显示的内容。title可加可不加

示例:

![blockchain](https://ss0.bdstatic.com/70cFvHSh_Q1YnxGkpoWK1HF6hhy/it/u=702257389,1274025419&fm=27&gp=0.jpg"区块链")

效果如下:

blockchain

上传本地图片直接点击导航栏的图片标志,选择图片即可

六、超链接

语法:

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

示例:

[简书](http://jianshu.com)[百度](http://baidu.com)

效果如下:

简书

百度

注:Markdown本身语法不支持链接在新页面中打开,貌似简书做了处理,是可以的。别的平台可能就不行了,如果想要在新页面中打开的话可以用html语言的a标签代替。

超链接名示例简书

七、列表

无序列表

语法:

无序列表用 - + * 任何一种都可以

- 列表内容

+ 列表内容

* 列表内容

注意:- + * 跟内容之间都要有一个空格

效果如下:

列表内容

列表内容

列表内容

有序列表

语法:

数字加点

1.列表内容

2.列表内容

3.列表内容

注意:序号跟内容之间要有空格

效果如下:

1.列表内容

2.列表内容

3.列表内容

列表嵌套

上一级和下一级之间敲三个空格即可

一级无序列表内容

二级无序列表内容

二级无序列表内容

二级无序列表内容

一级无序列表内容

二级有序列表内容

二级有序列表内容

二级有序列表内容

一级有序列表内容

二级无序列表内容

二级无序列表内容

二级无序列表内容

一级有序列表内容

二级有序列表内容

二级有序列表内容

二级有序列表内容

八、表格

语法:

表头|表头|表头---|:--:|---:内容|内容|内容内容|内容|内容第二行分割表头和内容。- 有一个就行,为了对齐,多加了几个文字默认居左-两边加:表示文字居中-右边加:表示文字居右注:原生的语法两边都要用| 包起来。此处省略

示例:

姓名|技能|排行--|:--:|--:刘备|哭|大哥关羽|打|二哥张飞|骂|三弟

效果如下:

姓名技能排行

刘备哭大哥

关羽打二哥

张飞骂三弟

九、代码

语法:

单行代码:代码之间分别用一个反引号包起来

`代码内容`

代码块:代码之间分别用三个反引号包起来,且两边的反引号单独占一行

(```)

  代码...

  代码...

  代码...

(```)

注:为了防止转译,前后三个反引号处加了小括号,实际是没有的。这里只是用来演示,实际中去掉两边小括号即可。

示例:

单行代码

`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

作者:高鸿祥

链接:https://www.jianshu.com/p/191d1e21f7ed

來源:简书

简书著作权归作者所有,任何形式的转载都请联系作者获得授权并注明出处。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,684评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,143评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,214评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,788评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,796评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,665评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,027评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,679评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,346评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,664评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,766评论 1 331
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,412评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,015评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,974评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,073评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,501评论 2 343

推荐阅读更多精彩内容

  • markdown是一种纯文本格式的标记语言。通过简单的标记语法,它可以使普通文本内容具有一定的格式。 相比WYSI...
    像计算机一样思考阅读 365评论 0 0
  • markdown是一种纯文本格式的标记语言。通过简单的标记语法,它可以使普通文本内容具有一定的格式。 相比WYSI...
    码仔李阅读 296评论 0 0
  • 转载自:https://www.cnblogs.com/crazyant007/p/4220066.html、 目...
    飞向深空阅读 476评论 0 0
  • 今天告诉大家一个好用的编辑器Markdown,他是一种纯文本格式的标记语言。通过简单的标记语法,它可以使普通文本内...
    锋享前端阅读 57,097评论 3 44
  • Spring Boot应用的测试——Mockito - 简书http://www.jianshu.com/p/97...
    葡萄喃喃呓语阅读 919评论 0 0