码迷,mamicode.com
首页 > Web开发 > 详细

Markdown语法学习(Github/git.oschina.net上README.md书写规范)(转)

时间:2017-04-30 01:03:40      阅读:227      评论:0      收藏:0      [点我收藏+]

标签:prot   比较   决定   参考   net   分隔线   fill   手册   activity   

晚上在更新git.oschina.net项目时,突然想知道README.md后缀的来源,于是搜了下,发现README.md使用了一种小标记语言Markdown的语法,于是简单的看了一个,特转载如下,为了下次参考方便(http://blog.csdn.net/kaitiren/article/details/38513715也不错)。中文参考手册可以参考http://wowubuntu.com/markdown/index.html

Markdown 的目标是实现「易读易写」,兼容HTML。

但是,在 HTML 区块标签间的 Markdown 格式语法将不会被处理。比如,你在 HTML 区块内使用 Markdown 样式的*强调*会没有效果。也就是说,Markdown 与HTML标签不能嵌套使用

 

 

 

Markdown 支持两种标题的语法,类 Setext 和类 atx 形式。

类 Setext 形式是用底线的形式,利用 = (最高阶标题)和 - (第二阶标题),例如:

This is an H1=============
This is an H2-------------

任何数量的 = 和 - 都可以有效果

类 Atx 形式则是在行首插入 1 到 6 个 # ,对应到标题 1 到 6 阶,例如:

# 这是 H1

## 这是 H2

###### 这是 H6

你可以选择性地「闭合」类 atx 样式的标题,这纯粹只是美观用的,若是觉得这样看起来比较舒适,你就可以在行尾加上 #,而行尾的# 数量也不用和开头一样(行首的井字符数量决定标题的阶数):

# 这是 H1 #

## 这是 H2 ##

### 这是 H3 ######

 

 

 

列表

 

Markdown 支持有序列表和无序列表。

无序列表使用星号、加号或是减号作为列表标记:

*   Red*   Green*   Blue

等同于:

+   Red+   Green+   Blue

也等同于:

-   Red-   Green-   Blue

有序列表则使用数字接着一个英文句点:

1.  Bird2.  McHale3.  Parish

很重要的一点是,你在列表标记上使用的数字并不会影响输出的 HTML 结果,上面的列表所产生的 HTML 标记为:

<ol><li>Bird</li><li>McHale</li><li>Parish</li></ol>

如果你的列表标记写成:

1.  Bird1.  McHale1.  Parish

或甚至是:

3. Bird1. McHale8. Parish

 

 

 

代码区块

 

和程序相关的写作或是标签语言原始码通常会有已经排版好的代码区块,通常这些区块我们并不希望它以一般段落文件的方式去排版,而是照原来的样子显示,Markdown 会用 <pre> 和 <code> 标签来把代码区块包起来。

要在 Markdown 中建立代码区块很简单,只要简单地缩进 4 个空格或是 1 个制表符就可以,例如,下面的输入:

这是一个普通段落:
    这是一个代码区块。

Markdown 会转换成:

<p>这是一个普通段落:</p>
<pre><code>这是一个代码区块。
</code></pre>

 

 

 

分隔线

 

你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线:

* * *

***

*****

- - -

---------------------------------------

 

 

 

图片

 

很明显地,要在纯文字应用中设计一个「自然」的语法来插入图片是有一定难度的。

Markdown 使用一种和链接很相似的语法来标记图片,同样也允许两种样式: 行内式和参考式。

行内式的图片语法看起来像是:

![Alt text](/path/to/img.jpg)
![Alt text](/path/to/img.jpg "Optional title")
  • 一个惊叹号 !
  • 接着一个方括号,里面放上图片的替代文字
  • 接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上 选择性的 ‘title‘ 文字。

参考式的图片语法则长得像这样:

![Alt text][id][id]是图片参考的名称,图片参考的定义方式则和连结参考一样:
[id]: url/to/image  "Optional title attribute"

到目前为止, Markdown 还没有办法指定图片的宽高,如果你需要的话,你可以使用普通的 <img> 标签。

=============================================================================
脚本如下图:
 
技术分享
 
效果如下图:
 
技术分享
 
 
脚本内容如下:
[html] view plain copy
 
  1. alarmclock  
  2. ==  
  3. alarmclock  
  4. -  
  5. alarmclock  
  6.   
  7. *single asterisks*  
  8.   
  9. **double asterisks**  
  10.   
  11. ***tripple asterisks***  
  12.   
  13. - - -  
  14. * * *  
  15.   
  16. 这是一个普通段落:  
  17.   
  18. protected void onCreate(Bundle savedInstanceState) {  
  19. super.onCreate(savedInstanceState);  
  20. setContentView(R.layout.activity_main);  
  21. iniView();   
  22. }  
  23.   
  24. ![github](/res/drawable-hdpi/ic_launcher.png)  
技术分享

Markdown语法学习(Github/git.oschina.net上README.md书写规范)(转)

标签:prot   比较   决定   参考   net   分隔线   fill   手册   activity   

原文地址:http://www.cnblogs.com/zhjh256/p/6786548.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!