Markdown的说明文档

Markdown

导语:

Markdown是一种轻量级『标记语言』,它允许人们“使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档”。
创始人为约翰·格鲁伯(John Gruber),初始版本发布在2004年3月19日。

一、关于Markdown

文本格式一种规范,使用简洁的语法代替繁琐的排版,与HTML语言相比,特点是显而易见的,多种语法,字体样式、颜色等等设置都是相对简单得多的。相对简单的语法,使我们能更专心于书写自己的文档。所以越来越多的博客平台也都相继开始兼容markdown格式,例如github的README,就是最好的代表,国内的博客平台有:Oschina,简书,CSDN等等。

Markdown官相关文档

使用Markdown的优点

  • 专注文本,而不是排版
  • 多种格式可供导出(PDF、HTML等)
  • 纯文本格式,多平台兼容
  • 可读性强,可供多种人群读写

Markdown开发工具

Windows

MAC

浏览器

二、Markdown语法

作用域

像很多的其他编程语言一样,每个方法或者类都有一个范围或权限修饰符。而markdown的语法范围几乎都是对称的(例如:*Hello World!*),又开始必然有结束,当然也有一些特殊的类型只有开始符号(例如:#标题),在其结尾部分需要通过2个空格和换行来去其他部分区分

语法

  • 标题


    标题是每篇文章都需要也是最常用的格式,在 Markdown 中,如果一段文字被定义为标题,只要在这段文字前加 # 号即可。

    # 一级标题

    ## 二级标题

    ### 三级标题

  • 列表
    列表有有序列表与无序列表的区别,在 Markdown 下,列表的显示只需要在文字前加上 - 或 * 即可变为无序列表,有序列表则直接在文字前加 1. 2. 3. 符号要和文字之间加上一个字符的空格。

  • 引用
    如果你需要引用一小段别处的句子,那么就要用引用的格式。

  • 链接
    链接文字的括号后面再接上另一个方括号,而在第二个方括号里面要填入用以辨识链接的标记,在解释标示的地方加上链接地址和说明;当然也可以直接用括号加上链接地址:

This is [an example][id] reference-style link.
[id]: http://example.com/ "Optional Title Here"

或者
This is [an example](http://example.com/) reference-style link.

  • 图片
    插入链接与插入图片的语法很像,区别在一个!号。可以先将图片上传到自己的云空间,生成可以访问的外链即可。
  • 粗体与斜体
    Markdown 的粗体和斜体也非常简单,用一个 * 包含一段文本就是斜体的语法,用两个 * 包含一段文本就是粗体的语法,用三个 * 包含一段文本就是斜体加粗体的语法。
    例如:
    这里是粗斜体
    这里是粗体
    这里是斜体加粗体

  • 表格
    表格是Markdown中最烦的语法,"|"表示表格范围,"-"表示内容范围,":"表示对齐方式(:------左对齐,---:右对齐,---:中间对齐) 例子如下:

Tables Are Cool
col 3 is right-aligned $1600
col 2 is centered $12
zebra stripes are neat $1

源代码
| Tables| Are | Cool |
| ------------- |:-------------:| -----:|
| col 3 is | right-aligned | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat |$1 |

  • 代码框
    如果你是个程序猿,需要在文章里优雅的引用代码框,在 Markdown 下实现也非常简单,只需要用两个 "`" 把中间的代码包裹起来,如 code。也可使用 tab 键即可缩进。

  • 分割线
    分割线的语法只需要另起一行,连续输入三个星号 *** 即可。

  • 脚注
    用来表示一些注解
    hello[^hello]

效果:
hello[1]

总结

目前总计10种语法格式,再借助工具,学习成本比较低;在使用过程中很多公司也在使用Md来开发接口文档,这样会便于版本管理,这可能会是未来的一个趋势和潮流。

三、转义

在前面加上反斜杠来帮助插入普通的符号

.END.


  1. hi

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,607评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,047评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,496评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,405评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,400评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,479评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,883评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,535评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,743评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,544评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,612评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,309评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,881评论 3 306
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,891评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,136评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,783评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,316评论 2 342

推荐阅读更多精彩内容

  • 公司新增的产品中用Markdown来编写产品更新日志,怎么在团队中介绍和推广Markdown的使用落到我身上。就简...
    莉莉妮特阅读 590评论 0 2
  • 1. 斜体和粗体 代码: 显示效果: 这是一段斜体 这是一段粗体 这是一段加粗斜体 这是一段删除线 2. 分级标题...
    泊牧阅读 2,318评论 0 2
  • 清歌入岁月, 红颜染光阴。 往事一廉悠梦, 韶华记青春。 此生南来北去, 浪漫只为缘分, 山水遇知音。 千古一段唱...
    曹焕甫阅读 1,222评论 0 1
  • 《轻》 一池碎萍三分春; 鸭绿波轻草初青。
    自命飞皇Yoes阅读 329评论 0 1
  • 何老师的大致建议: 想要整个工作的系统和规范化,仅仅一场培训是不够的。 几个步骤: 1-收集信息:可以通过访问,结...
    我怎愚你阅读 279评论 4 0