readme.md常用格式的编写

md是Markdown的缩写,md是一种易读易写的文本格式(easy-to-read, easy-to-write plain text format),并且可以很方便的转换成HTML格式显示在网页中。 以后项目的readme就可以用md格式编写了,下面列出了md格式的基本语法。
 
标题 Headings:
# 标题 1 (对应HTML中的标签)
## 标题 2 (对应HTML中的标签)
......
###### 标题 6 (对应HTML中的标签)
 
注意:标题与#之间要留一个空格
 
段落 Paragraph :
两段文字之间至少要留有一个空行(one or more blank lines)
 
字体 Styling Text:
斜体: *This text will be italic*  (对应HTML中的标签)
粗体:**This text will be bold** (对应HTML中的标签)
 
列表 Lists:
无序号的列表 Unordered Lists
* item 
* item
或者
- item
- item
注意: *和-要与列表内容之间要有空格, *是实心的圆点,-是空心的圆点
 
有序号的列表 Ordered List:s
1. item
2. item
注意: 列表序号与列表内容之间要有空格
 
嵌套的列表 Nested Lists:
1. item
  1.1 item
  1.2 item
注意: 嵌套列表要缩进2个空格  indenting list items by two spaces
 
引用 Blockquotes:
引用文字前填加 > (indicate blockquotes with a >)
> 引用文本
 
代码快 Code Block
To produce a code block in Markdown, simply indent every line of the block by at least 4 spaces or 1 tab.
在每行代码前,使用4个空格或者tab缩进。
例如:
# Title
    if x > y:
        print x
 
链接 Links:
把链接文字放在中括号[]中,把对应的URL放到小括号()中。(wrapping link text in brackets [ ], and then wrapping the link in parenthesis ( ) ).
[Sina Blog](blog.sina.com.cn)
 
参考URL:
1. https://help.github.com/articles/markdown-basics
2. http://zhangchi.de/post/intro-to-markdown.html

转载于:https://www.cnblogs.com/lijie33402/p/4490538.html

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值