Giter Club home page Giter Club logo

markdown's Introduction

MarkDown书写规范

写文档好帮手,轻量级标记语言 Markdown

#概述

##起源

Markdown是Daring Fireball的作者John Gruber发明,身为Blogger,可能他也觉得传统的HTML有些复杂吧,退一步来讲,若是一个毫无计算机基础的Blogger,根本也没必要去掌握那些复杂的标签语言知识。

##宗旨

Markdown 的目标是实现「易读易写」,成为一种适用于网络的书写语言。

可读性,无论如何,都是最重要的。一份使用 Markdown 格式撰写的文件应该可以直接以纯文本发布,并且看起来不会像是由许多标签或是格式指令所构成。Markdown 语法受到一些既有 text-to-HTML 格式的影响,包括 Setext、atx、Textile、reStructuredText、Grutatext 和 EtText,而最大灵感来源其实是纯文本电子邮件的格式。

总之, Markdown 的语法全由一些符号所组成,这些符号经过精挑细选,其作用一目了然。比如:在文字两旁加上星号,看起来就像强调。Markdown 的列表看起来,嗯,就是列表。Markdown 的区块引用看起来就真的像是引用一段文字,就像你曾在电子邮件中见过的那样。

##兼容 HTML

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

不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。不需要额外标注这是 HTML 或是 Markdown;只要直接加标签就可以了。

要制约的只有一些 HTML 区块元素――比如 <div><table><pre><p>等标签,必须在前后加上空行与其它内容区隔开,还要求它们的开始标签与结尾标签不能用制表符或空格来缩进。Markdown 的生成器有足够智能,不会在 HTML 区块标签外加上不必要的 <p> 标签。

###Editorially上有一个简单的比较:

html

md

上面是HTML语法,下面则是Markdown语法,最终产生的格式一模一样。

#全局规范

MarkDown 文件均使用.md作为后缀 (小写字母)

普通文本换行,使用行末尾2空格触发

##发展

越来越多的软件和服务支持Markdown语法,应该说,Mac上大多数的写作软件都支持它。在线工具同样有很多,如果你的博客基于Wordpress或是blogger,它同样支持发布。

不仅仅是写博客,一切文章都可以用Markdown语法来写,比如说你想将一个标题加大字体,只需要在相应文字前面加上一个#或是在它的下一行加上一些等号即可,还有比这更简单的调整格式方式吗?

#语法参见

官方语法说明

GitHub MakDown 语法

PDF版本

#Markdown 免费编辑器

##Windows 平台

##Linux 平台

##Mac 平台

##在线编辑器

  • Draftin:功能强大,可发布到各种博客平台。

  • Dillinger:实时预览,支持直接保存到Dropbox或是Github。

  • Markable:实时预览,支持发布到Tumblr。

  • Oak:不支持发布到任何地方,供在线随手记录东西使用。

  • 简书:国产软件,看上去不错。

##浏览器插件

##高级应用

*** 如有更好的 Markdown 免费编辑器推荐,请到这里反馈,谢谢!

注:本文档符合自身规范,可视作demo,参看源码,欢迎大家 fork 补充完善。

#DEMO Start

##标题


一共有六级标题,1-6个#表示

#一级标题

一级标题也可以用底线是=表示,任何数量都可以

##二级标题

二级标题也可以用底线是-表示,任何数量都可以

###三级标题

####四级标题

#####五级标题

######六级标题

##强调


single asterisks

single underscores

double asterisks

double underscores

粗体**包围

斜体*包围

##引用


上面的横线用三个-表示

区块引用

fdfd

##删除


删除他

##列表


  • red
  • green
  • blue
  • red
  • green
  • blue
  • red
  • green
  • blue
  1. red
  2. green
  3. blue
  • 一个列表包含一个区块

fdfdfdfd

dfdfdfdfd

##代码


代码写在这里

public static void main()

this is method printf('\n');

function method()
{
    alert("javascript");
}
class Test{
    public static void main(String argc[]){
        System.out.println("java");
    }
}
class Test{
    public static void main()
    {
        Console.WriteLine("C#");
    }
}

##link


行内连接github的链接

See my About page for details.

This is an example reference-style link.

下面这三种链接的定义都是相同

[foo]: http://example.com/ "Optional Title Here"

[foo]: http://example.com/ 'Optional Title Here'

[foo]: http://example.com/ (Optional Title Here)

I get 10 times more traffic from Google than from Yahoo or MSN.

##图片


github logo

github logo

![github logo][logo] [logo]: https://raw.githubusercontent.com/hoosin/PPT/master/github/logo.png "Optional title attribute"

##表格

ID名称 命名 ID名称 命名
头部 header 主体 main
脚部 footer 容器 wrapper
侧栏 side_bar 栏目 column
布局 layout

##分隔线





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

##其它


###自动链接 http://github.com/ diff http://github.com/

###反斜杠

*literal asterisks*

Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:

\ 反斜线

` 反引号

* 星号

_ 底线

{} 花括号

[] 方括号

() 括弧

# 井字号

+ 加号

- 减号

. 英文句点

! 惊叹号

##GFM 与标准SM 不一样的地方

  • GFM二级标题自动带有下划线

  • GFM在issue中通过#和数字自动链接到对应的issue(request也支持)(eg:#1)

  • GFM自动识别链接,链接不用尖括号括起来也会被认为是链接。

  • GFM实现代码语法高亮

  • GFM自动@别人

  • GFM自动引用,包括项目,用户名,issue等

  • GFM支持任务列表

    • [] task #1
    • [] task item
    • complete

markdown's People

Contributors

hoosin avatar itachime avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.