Markdown编写github README.md

Markdown编写github README.md

一、在线编辑器StackEdit

Markdown在线编辑器地址

中文：https://www.zybuluo.com/mdeditor

英文：https://stackedit.io/

今天推荐一款web应用StackEdit，体验一流，功能强大。

进入后就是编辑界面，和一般的markdown相同，左边是MD代码，右侧是渲染后的文档预览。

貌似没神马特点嘛~markdown编辑器就是这样啦，基本功能上都一样，支持拼写检查，排版风格简洁美观。网站提供4种主题，都挺抗疲劳的。

特色功能1：丰富的导出和同步功能

==============================

点击顶部左侧的按钮，会弹出来一个菜单，里面有两组选项：同步和发布。

同步是指将当前文档与Google Docs或Dropbox中的文档同步，这样在StackEdit中的任何改动就都会同步到第三方网站。

发布是单纯地导出，提供的选项很多，除了常见的Dropbox、Blogger，还支持Github或SSH。

特色功能2：支持自定义导出模版

==============================

StackEdit可以导出HTML和PDF格式的文档，这两种文档的格式是可以由用户自定义的。打开Setting里面的Services即可找到。

特色功能3：便捷的浏览工具

==============================

在浏览界面，StackEdit也提供了十分人性化的工具。

Markdown syntax是介绍markdown基本语法的界面。

Table of contents是根据标签提取出来的文档目录

Statistics是当前文档的统计数据

HTML code是当前文档渲染后额html代码

来源：http://www.guokr.com/post/544861/

二、基本语法

Markdown语法

Markdown 语法速查表

1 标题与文字格式

标题

# 这是 H1 <一级标题>

## 这是 H2 <二级标题>

###### 这是 H6 <六级标题>

文字格式

**这是文字粗体格式**

*这是文字斜体格式*

~~在文字上添加删除线~~

2 列表

无序列表

* 项目1

* 项目2

* 项目3

有序列表

1. 项目1

2. 项目2

3. 项目3

   * 项目1

   * 项目2

3 其它

图片

![图片名称](http://gitcafe.com/image.png)

链接

[链接名称](http://gitcafe.com)

引用

> 第一行引用文字

> 第二行引用文字

水平线

***

代码

`<hello world>`

代码块高亮

“`ruby

  def add(a, b)

    return a + b

  end

“`

表格

  表头  | 表头

  ————- | ————-

 单元格内容  | 单元格内容

 单元格内容l  | 单元格内容

大标题

===================================

  大标题一般显示工程名,类似html的\<h1\><br />

  你只要在标题下面跟上=====即可

中标题

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

  中标题一般显示重点项,类似html的\<h2\><br />

  你只要在标题下面输入------即可

### 小标题

  小标题类似html的\<h3\><br />

  小标题的格式如下 ### 小标题<br />

  注意#和标题字符中间要有空格

### 注意!!!下面所有语法的提示我都先用小标题提醒了!!!

### 单行文本框

    这是一个单行的文本框,只要两个Tab再输入文字即可

### 多行文本框

    这是一个有多行的文本框

    你可以写入代码等,每行文字只要输入两个Tab再输入文字即可

    这里你可以输入一段代码

### 比如我们可以在多行文本框里输入一段代码,来一个Java版本的HelloWorld吧

    public class HelloWorld {

      /**

      * @param args

   */

   public static void main(String[] args) {

   System.out.println("HelloWorld!");

   }

    }

### 链接

1.[点击这里你可以链接到www.google.com](http://www.google.com)<br />

2.[点击这里我你可以链接到我的博客](http://guoyunsky.iteye.com)<br />

###只是显示图片

![github](http://github.com/unicorn.png "github")

###想点击某个图片进入一个网页,比如我想点击github的icorn然后再进入www.github.com

[![image]](http://www.github.com/)

[image]: http://github.com/github.png "github"

### 文字被些字符包围

> 文字被些字符包围

>

> 只要再文字前面加上>空格即可

>

> 如果你要换行的话,新起一行,输入>空格即可,后面不接文字

> 但> 只能放在行首才有效

### 文字被些字符包围,多重包围

> 文字被些字符包围开始

>

> > 只要再文字前面加上>空格即可

>

>  > > 如果你要换行的话,新起一行,输入>空格即可,后面不接文字

>

> > > > 但> 只能放在行首才有效

### 特殊字符处理

有一些特殊字符如<,#等,只要在特殊字符前面加上转义字符\即可<br />

你想换行的话其实可以直接用html标签\<br /\>

来源：http://guoyunsky.iteye.com/blog/1781885