为什么不用Markdown来写设计文档

why write this blog

之前只有在用一些笔记软件的时候偶尔接触过markdown这个东西,只知道是一种轻型的标记语言。现在工作还有各方面的需要,必须抽出一些时间系统的学习一下markdown。当然并不研究markdown的渲染原理,只学习用法。

[TOC]

Markdown简介

wiki上的介绍

Markdown is a lightweight markup language with plain text formatting syntax. It's designed so that it can be converted to HTML and many other formats using a tool by the same name.

这么看,markdown的设计初衷肯定不是面向码农了,受众应该是经常写文档,写邮件的办公室一族了。

Markdown提供一套规定的语法,让写出的文档经过markdown processer的处理,转化为html,从而格式化你的.md文件。

当然,到了现在,Markdown的使用范围和影响已经渗透到各个行业,许多人日常的工作经常需要和它打交道。Github天生对md文件的支持,国内博客如简书也流行起markdown的方式来写博客。而抽出一小时左右的时间就能学会并使用它,还是非常值得,希望这篇blog会对你们有所帮助。

Editor

工欲善其事,必先利其器。这里我推荐typero

下面是我写这篇博客时的截图

typero
typero
  • 功能齐备

  • mac/windows的跨平台支持

  • 界面清爽,cold style

  • markdown的语法建和快捷键的绑定

准备好之后,开始markdown的学习。

区块元素

标题

标题用 # 来提示markdown引出标题,一共有六级标题,字体从大到小。合理的在一篇文章中使用标题,可以通过 [toc] 自动生成目录,而且让你的文章层次更加清楚。

# header1
## header2
...
####### header6

header效果:

header
header

引用

使用 > 符号,引用的范围很广,通用解释、官方定义、他人专利都推荐用引用格式。

> 输入引用的内容

blockquotes效果:

blockquotes
blockquotes

列表

un-orded list

使用 - 来创建无序列表,+ * 具有相同的作用。

## programming language
- c++
- pyhton
- go
- java

orded list

有序列表,使用 1. item1 来创建,可以不按顺序,markdown语法解析器会自动识别

## popular
1. javascipt
2. pyhthon 
3. java

task list

也就是html中的复选框,使用 - [] 来创建,默认不选中,- [x] 为默认选中的复选框

 - [] option1
 - [] option2
 - [x] options

效果如下:

  • [ ] option1
  • [ ] option2
  • [x] option3

code block

很多博客和笔记软件都支持加入代码块这个功能,可以保持代码的原貌。在typero中是使用 ``` 来加入代码块,其他editor可能略有不同。

for a in list
    func(a)

links

markdown支持两种link方式,inline和reference。两种方式都是用 [ ] 来修饰需要链接的对象。

  • inline links

    在需要链接的对象后面,用括号加上links即可。用符号表示就是 [object] 后面加上 (links "title") title是可选项。如果链接访问的本地主机的资源,可以用相对路径代替url

    [Baidu](http://baidu.com/ "baidu") is a famous company.
    
    See my [About](/about/) page for details.
    

    效果:

    Baidu is a famous company.

    See my About page for details.

  • reference links

    与inline不同的是,它不直接指明链接的地址。而是在 [object] 后面跟上一个 [identifier] ,然后在文件的合适地方,给identifier定义一个links,这样object就能通过唯一的identifier找到自己的links。如果 [identifier] 为空,则默认和 [object] 同名

    [Tencent][qq] has been the best internet company in Asia.
    

    效果:

    Tencent has been the best internet company in Asia.

images

images的用法和links基本相似,只是加了一个 ! 在前面

inline式的语法如下:

![](/path/to/img.jpg)

![](/path/to/img.jpg "Optional title")

reference式的语法如下:

![Alt text][id]

[id]: url/to/image  "Optional title attribute"

table

创建表格,使用|header1|header2|...|headern| 来创建n列的表格,自动生成表格之后可以调节表格大小。

id name score
1 Allen 100
2 James 90
3 Victoria 95

Footnotes

创建脚注

You can create footnotes like this[^footnote].

[^footnote]: Here is the *text* of the **footnote**.

效果:

You can create footnotes like this[1].


TIPs

  • 需要注意markdown中有意义的符号,在写文章时可能会出现冲突,比如下面这个例子

    1994. the year i was born
    

    我的目的只是将它作为普通语句输入,解释markdown的语法解析器会把它误认为列表的提示键,这种情况需要引入 \ 转义符,正确用法如下

    1994\. the year i was born
    
  • 强调语法,使用**word** 来加粗,*word* 使字体变斜

    _* 是同样的作用

  • TOC 用法,使用 [toc] 来生成目录,前面已介绍

  • 下划线,可以使用下面的符号生成

    ---
    ------
    ***
    ******
    
  • 简短的代码引用可以用code就可以,比如 printf 是输出语句

  • 插入image稍微麻烦一些,本地图片很方便,其他的可以用七牛云图片存储。

  • :smile :happy: 可以输入emoji

    ​比如::open_hands: :clap: :haha:


  1. Here is the text of the footnote.

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

推荐阅读更多精彩内容

  • OverView 概述 Markdown is created by Daring Fireball, the o...
    小林记阅读 9,830评论 6 51
  • Typora的Syntax以此文最好,摘录之。 原文:小林记(http://www.jianshu.com/p/d...
    comma7456阅读 2,619评论 0 2
  • 推荐一款markdown编辑器Typora,免费,兼容mac和win,显示效果非常棒,用起来也非常舒服,下面的标记...
    vv源vv阅读 3,036评论 0 49
  • ------学点管理学,让你破局而出。 每个人都困在一个“局”里,人生就是一连串的“破局”的过程。这句话是清华大学...
    张睿芳伊阅读 256评论 0 1
  • 开始的第一篇,给每一个自己听。 本以为今天又会和平时一样,翻翻手机上的软件,看看身边人他们一天的喜怒哀乐 感慨万千...
    慢慢小鱼阅读 449评论 4 1