• 做一个幸福的人,读书,旅行,努力工作,关心身体和心情。
  • 不管有没有人爱,也要努力做一个可爱的人。不埋怨谁,不嘲笑谁,也不羡慕谁,阳光下灿烂,风雨中奔跑,做自己的梦,走自己的路。

Markdown 语法说明

分享 lcq 2年前 (2016-08-08) 869次浏览 0个评论

在Github上面溜达过的人都知道,每个项目的首页都有一个说明文件README.md。这个文件是使用 Markdown 语法写的。最近使用 Markdown 写了oms2.0项目的README.md,感觉还不错。做个记录。

Markdown的语法很简单,一张图片就能够说明。这张图片不是我总结的,我是在一个pdf上面截图下来的,然后用Windows自带的画图软件将他们合并到一起。只要记住了这张图片的 Markdown 语法,使用 Markdown 写东西就基本没什么问题了。上图!

markdown

其他Markdown语法

主要是针对上面图片里面没有提及的做一个补充!

1、表格。使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。当然为了美观,可以使用空格对齐不同行的单元格,并在左右两侧都使用 | 来标记单元格边界。在表头下方的分隔线标记中加入 :,即可标记下方单元格内容的对齐方式::--- 代表左对齐,:--: 代表居中对齐,---: 代表右对齐。如果不使用对齐标记,单元格中的内容默认左对齐;表头单元格中的内容会一直居中对齐(不同的实现可能会有不同表现)。表格中可以插入其他 Markdown 中的行内标记。例如:

name age blog
Luchenqun 12 luchenqun
Chen 32 coolshell

2、做一份待办事项。使用带有 - [ ]- [x] (未完成或已完成)项的列表语法撰写一个待办事宜列表,并且支持子列表嵌套以及混用Markdown语法,当然,可能各个实现表现有所不同。例如:

七月旅行准备

准备邮轮上需要携带的物品 浏览日本免税店的物品 购买蓝宝石公主号七月一日的船票

一些小技巧

1、如何换行?你可以使用<br />标签,因为Markdown本来就支持HTML标签。你也可以按几个回车键来换行。这两种方法都感觉有点不好。前者引入HTML标签,后者感觉空了很多不舒服。有一种比较好的解决方案。敲两个以上空格然后按回车键,就换行可以写其他文字了!

参考文章

1、MarkDown标记语言说明文档——如何在github上写出优秀的readme

2、GitHub上README写法暨GFM语法解读

3、Markdown 语法说明


乐趣公园 , 版权所有丨如未注明 , 均为原创丨本网站采用BY-NC-SA协议进行授权 , 转载请注明Markdown 语法说明
喜欢 (0)
发表我的评论
取消评论

表情 贴图 加粗 删除线 居中 斜体 签到

Hi,您需要填写昵称和邮箱!

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址