.md(markdown)文件的基本编写语法


构建一个项目,往往需要反复实践与验证,初始构建使用xmind整理思路与需求,初具模型后,通过visio呈现流程+md说明性文件,以便团队开发。

  • 本文是我学习.md的笔记。

什么是 Markdown

Markdown 是一种轻量级标记语言,创始人为约翰·格鲁伯(John Gruber)。它允许人们「使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档 」—— 维基百科>Markdown具有一系列衍生版本,用于扩展Markdown的功能(如表格、脚注、内嵌HTML等等),这些功能原初的Markdown尚不具备,它们能让Markdown转换成更多的格式,例如LaTeX,Docbook。Markdown增强版中比较有名的有Markdown Extra、MultiMarkdown、 Maruku等。这些衍生版本要么基于工具,如Pandoc;要么基于网站,如GitHub和Wikipedia,在语法上基本兼容,但在一些语法和渲染效果上有改动。如果你看不懂以上对 Markdown 的定义,那也无所谓。约翰·格鲁伯自己对Markdown的描述的重点也在于

标题

  • 第一种: 前面带 # h几即前面写几个 #
# 一级标签          >     <h1>一级标签</h1>
  • 第二种: 只能表示一级和二级标题,=和-的数量不限制,大于一个即可
 一级标签           >     <h1>一级标签</h1>
=========
  • 第三种: 和第一种方式不同之处是 添加了结束标签
  # 一级标题 #                  >      <h1>一级标签</h1>
  ## 二级标题 ##              >      <h2>二级标签</h2>
  ### 三级标题 ###          >      <h3>三级标签</h3>
  ...

列表

### 无序列表
* 1                             · 1       
+ 1            > 预览            · 1
- 1                             · 1  
<ul>
  <li>1</li>
  <li>1</li>
  <li>1</li>
</ul>

### 有序列表
1. 列表                            1. 列表     
2. 列表            > 预览          2. 列表
3. 列表                            3. 列表

!数字后面的点只能是英文点
!!有序列表的序号是根据第一行列表的数字顺序来的
<ol>
  <li>列表</li>
  <li>列表</li>
  <li>列表</li>
</ol>

引用

分割线

链接

  • 2种链接方式:行内式和参数式,链接文字用 [链接文字]标记 。
 ### 行内式
 [Windows/Mac/Linux 全平台客户端](https://www.zybuluo.com/cmd/)
<p><a href="https://www.zybuluo.com/cmd/">Windows/Mac/Linux 全平台客户端</a></p>

###参数式
[Windows/Mac/Linux 全平台客户端](https://www.zybuluo.com/cmd/ 'title属性')
<p><a href="https://www.zybuluo.com/cmd/" title="title属性">Windows/Mac/Linux 全平台客户端</a></p>

图片

![cmd-markdown-logo](https://www.zybuluo.com/static/img/logo.png)
<p><img src="https://www.zybuluo.com/static/img/logo.png" alt="cmd-markdown-logo" title="" /></p>
cmd-markdown-logo

代码段

  • 单行使用 `` [ 反引号,键盘中esc下面那个键/英文状态下 ]
 `我是单行文本`

预览结果 _> 我是单行文本

  • 多行使用 `````` 注意:这里是是前后三个 ```


文本样式

  *字体倾斜*                >        <em>字体倾斜</em>
  _字体倾斜_
  **字体加粗**              >        <strong>字体加粗</strong>
  __字体加粗__
  ~~字体删除~~              >        <del>字体删除</del>

  ! 符号与字体之间不要有空格

加强的代码块

支持四十一种编程语言的语法高亮的显示,行号显示。

非代码示例:
    ` ` `
      $ sudo apt-get install vim-gnome
    ` ` `
$ sudo apt-get install vim-gnome

JavaScript 示例:
`` ` javascript
/**

  • nth element in the fibonacci series.
    */
    function fib(n) {
    var a = 1, b = 1;
    return a;
    }
    document.write(fib(10));
    `` `
    !三个反引号之间没有空格
/**
* nth element in the fibonacci series.
*/
function fib(n) {
var a = 1, b = 1;
return a;
}
document.write(fib(10));

表格

| 项目        | 价格    |  数量   |
| --------    | -----: | :----:  |
| 计算机      | \$1600  |   5    |
| 手机        |   \$12  |   12   |
| 管线        |    \$1  |   234  |

: 是对齐方向
项目 价格 数量
计算机 $1600 5
手机 $12 12
管线 $1 234

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

推荐阅读更多精彩内容