原来Github上的README.md文件这么有意思——Markdown语言详解

 转载请注明出处：http://blog.csdn.net/zhaokaiqiang1992

 

以前一直在使用github，也在上面分享了很多的项目和Demo，每次建立新项目的时候，使用的都是默认的README.md文件，也未曾对这个文件有过什么了解。可是在看到别人写的项目的README.md里面居然有图片、连接什么的，就感到很好奇，这效果是什么加上去的？因而便查了一下资料，结果，竟迁出了一门历来没有了解过的语言— —Markdown！

    github上的README.md文件就是使用的Markdown语言编写的，咱们先简单介绍下这门语言的前因后果，而后再介绍一些基本的语法和使用。

 

    1.前因后果和语法特色

    Markdown 是一种轻量级标记语言，创始人为约翰·格鲁伯（John Gruber）。它容许人们“使用易读易写的纯文本格式编写文档，而后转换成有效的XHTML(或者HTML)文档”。这种语言吸取了不少在电子邮件中已有的纯文本标记的特性。

 

   Markdown 的目标是实现「易读易写」。可读性，不管如何，都是最重要的。一份使用 Markdown 格式撰写的文件应该能够直接以纯文本发布，而且看起来不会像是由许多标签或是格式指令所构成。Markdown 语法受到一些既有 text-to-HTML 格式的影响，包括Setext、atx、Textile、reStructuredText、Grutatext 和 EtText，而最大灵感来源实际上是纯文本电子邮件的格式。总之， Markdown 的语法全由一些符号所组成，这些符号通过精挑细选，其做用一目了然。好比：在文字两旁加上星号，看起来就像*强调*。Markdown 的列表看起来，嗯，就是列表。Markdown 的区块引用看起来就真的像是引用一段文字，就像你曾在电子邮件中见过的那样。

    Markdown 语法的目标是：成为一种适用于网络的书写语言。Markdown 不是想要取代 HTML，甚至也没有要和它相近，它的语法种类不多，只对应 HTML 标记的一小部分。Markdown 的构想不是要使得 HTML 文档更容易书写。在我看来， HTML 已经很容易写了。Markdown 的理念是，能让文档更容易读、写和随意改。HTML 是一种发布的格式，Markdown 是一种书写的格式。就这样，Markdown 的格式语法只涵盖纯文本能够涵盖的范围。

 

    正是由于Markdown的这些特色，并且功能比纯文本更强，所以有不少人用它写博客。世界上最流行的博客平台WordPress和大型CMS如joomla、drupal都能很好的支持Markdown。

 

          2.编辑软件

    若是咱们要写Markdown代码的话，咱们首先须要一个编辑器，由于我使用的是Mac，因此推荐使用Mou，很是的强大，很是的好用。

    下面是Mou的界面，左边是Markdown代码，右边是实时的展现效果，并且能够选择不一样的主题色，很是的漂亮！

 

 

    固然，若是你使用的是其余的平台的话，你能够选择在线的编辑器，效果也很是棒。

    给出两个在线的Markdown编辑器

     http://mahua.jser.me/

     http://maxiang.info/

    第一个是我的开发的，无偿使用，很是赞！

    第二个是一个已经发布的产品，能够免费在线编辑。除此以外，还能够将内容同步到印象笔记，不过只能试用10天，以后须要79/年，仍是很是不错的。

 

    3.经常使用语法介绍

      这里只介绍最经常使用和最多见的功能，若想查看所有的语法，请移步 http://wowubuntu.com/markdown/index.html

（1）标题

    标题使用不一样数量的"#"来标识是什么层级，能够对应于HTML里面的H1-H6，下面是示例代码和效果

 

 

    “========”风格的也能够，可是我不喜欢，赶不上"#"的好用

 

   （2）图片

    咱们可使用下面的语法，添加一个图片

    

    详细叙述以下：
    一个惊叹号 !
    接着一个方括号，里面放上图片的替代文字
    接着一个普通括号，里面放上图片的网址

 

    下面是一个示例

 

 

    （3）强调

    咱们可使用下面的方式给咱们的文本添增强调的效果

 

*强调* 或者 _强调_  (示例：斜体)
**加剧强调** 或者 __加剧强调__ (示例：粗体)
***特别强调*** 或者 ___特别强调___ (示例：粗斜体)

 

    下面是一个示例：

 

 

 

    （4）代码

    若是咱们想在文章中添加代码，咱们有两种方式

    第一种方式是使用反引号(esc键下面的按钮)将代码包裹起来

    下面是一个示例代码

 

 

    第二种方式则是使用制表符或者至少4个空格进行缩进的行

    下面是一个示例代码

 

 

 

    （5）换行

    若是咱们想把一行文本进行换行，咱们能够在须要换行的地方输入至少两个空格，而后回车便可，注意，若是不回车，是没有效果的，就像下面这样

 

 

 

   （6）引用

   若是咱们在文章中引用了资料，那么咱们能够经过一个右尖括号">"来表示这是一段引用内容。咱们能够在开头加一个，也能够在每一行的前面都加一个。咱们还能够在引用里面嵌套其余的引用，下面是一个示例：

 

 

 

（7）连接

    若是咱们文章中加入一个连接，那么咱们经过下面的方式添加

[连接文字](连接地址)
例子： [Markdown](http://blog.csdn.net/zhaokaiqiang1992)

 

 

 

    （8）分割线

    若是咱们想用分割线对内容进行分割，咱们能够在单独一行里输入3个或以上的短横线、星号或者下划线实现。短横线和星号之间能够输入任意空格。如下每一行都产生一条水平分割线。

 

 

 

    （9）列表标记

    若是咱们的内容须要进行标记，那么咱们可使用下面的方式

 

 

 

    好了，这些东西彻底够用了，休息，休息一下...