使用Markdown工具链优雅地写作(一)_Markdown介绍

使用Word进行长文本写作是一件极其痛苦的事,速度慢、文件大、文档风格难统一、排版效率低、容易崩溃、版本控制难等等,反正一堆难于忍受的缺点。
如果不想再忍受Word的缺点,不妨试试Markdown这种简单的轻量标记语言和与它相关的一系列可选工具链,或许会重新喜欢上写作或写笔记。

Markdown是什么

2004年, John GruberAaron Swartz 协同发布了Markdown这种为网络写作而生的轻量标记语法。很快地,随着开源程序员广泛使用,Markdown现在几乎成了程序员们的标配,目前最大的开源聚集地 github.com 到处弥漫着Markdown的身影。

Markdown是一种轻量标记语法,可以看成是 HTML 标记语言的一种简化,跟HTML一样,Markdown也以纯文本形式存储。

Markdown作为一种开源的语法,慢慢地就有大量的编辑器(现有的编辑器或新增的编辑器)支持它。

使用Markdown写作的文档一般会实时预览渲染成HTML文档进行查看,这样,即可以专心地进行文字写作不必分心调整格式和样式,又可以实时地看到排版的效果。

还可以将多个Markdown文档整理成电子书(EPUB, PDF, MOBI)。

不仅程序员使用Markdown, 简书(www.greatytc.com/ 也是国内使用Markdown的一个好例子。微信公众号文章也可以先使用Markdown写作后再将本地预览以 Ctrl - CCtrl - V 的方式快速排版(需要简单重新调整和上传图片)。

下图是Roming在本地书写本文的截图(左边书写,右边实时预览,最右边显示 TODO(待办) 事项):

markdown_writing_env.jpg

下图是Roming将本文源文件CTRL - C + CTRL - V到简书的截图:

jianshu_writing_env.jpg

Markdown的语法简述

自从Markdown发布以来,就有不少对Markdown语法进行扩展,几乎每一款常用的Markdown编辑器都或多或少地进行扩展,GitHub Flavored Markdown(GFM) 是其中重要的扩展之一。

网上关于Markdown语法的描述非常多,在任何一个搜索引擎中搜索 "Markdown语法" 都可以找到类似的语法说明。

如果有意于使用Markdown,建议仔细阅读下文“更多的延伸资料”链接中的 “Mastering Markdown(英文)”“Markdown语法说明(简体中文)”

下面是一个简单的语法例子:

源文件:

<!-- 字体标记 -->
粗体: **粗体** 或 __粗体__
斜体: *斜体* 或 _斜体_

<!-- 列表标记 -->
1. 有序列表项1
1. 有序列表项2
1. 有序列表项3

+ 无序列表项1
+ 无序列表项2
+ 无序列表项3

<!-- 链接 -->
[GitHub链接](http://github.com)

<!-- font awesome -->
:fa-car:    :fa-github:     :fa-github-alt:

渲染后:

粗体: 粗体粗体
斜体: 斜体斜体

  1. 有序列表项1
  2. 有序列表项2
  3. 有序列表项3
  • 无序列表项1
  • 无序列表项2
  • 无序列表项3

GitHub链接

:fa-car: :fa-github: :fa-github-alt:

简书貌似不支持Font Awesome

Markdown的优势及适合的写作任务

Markdown的优势:

  1. 纯文本格式:
    • 几乎任何工具都可以打开Markdown文档查看里面的内容
    • 文件小
    • 版本控制方便,不像Word这种二进制或压缩包文档,每一次版本更新都得整个文档提交并且难于跟综每一次的修改(事实上大部分写作者都会为一份文稿存储多个不同的文档并起不同名字以示不同版本的区别)
  2. 语法简单: Markdown的语法非常简单,只需 10几分钟 就可以上手
  3. CSS排版样式: 就是 HTML文档一样,配套不同的CSS样式文件就可以展示不同排版效果(Roming使用的CSS样式就是自定义的样式,其中的 自动编号 也是CSS的功能)
  4. HTML兼容: 当Markdown的无法满足特殊需要时,可以使用HTML标签进行定义,当然一般并不建议大量使用HTML标签,如果必须大量使用HTML标签建议使用 DIV + CSS 进行排版,这样可控性和结构性更好
  5. 工具链丰富: 像绝大多数开源工具一样,Markdown也不是一个孤立的语言或工具,Markdown可以整合Git、PlantUML、GitBook、Mindmap等大量工具

Markdown适合的写作任务:

  1. 发布在网络上的文档
  2. 电子书
  3. 笔记
  4. 软件说明书

Markdown的劣势及不适合的写作任务

Markdown的劣势:

  1. 简单: 视乎不同的任务,简单即是Markdown的优点,也是Markdown的缺点,虽然可以通过CSS样式定义不同的样式,然后在不同章节、段落套用相应的样式,但这违背了Markdown的初衷,书写起来也会变得异常复杂
  2. 标准不统一: 虽然Markdown也制定了 CommonMark 标准,但实际上这个标准并没有太大作用

Markdown不适合的写作任务:

  1. 纸质出版物(纸质书籍、论文等)
  2. 格式样式复杂的文档(大量不同字体、复杂表格等)
  3. 版式复杂的文档(大量分栏、不同章节不同版式等)
  4. 行政文档(公司公文等)

更多的延伸资料

  1. Markdown官方网页: https://daringfireball.net/projects/markdown/
  2. Mastering Markdown(英文): https://guides.github.com/features/mastering-markdown/
  3. Markdown语法说明(简体中文): https://coding.net/help/doc/project/markdown.html
  4. macOS文档神器 Dash 里的Markdown的语法说明(英文)
  5. GFM规范: https://github.github.com/gfm/
  6. 《GFM规范》发布的简体中文报道: https://linux.cn/article-8399-1.html
  7. GoogleBaidu 搜索 "Markdown" 获取更多的信息
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,290评论 6 491
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,107评论 2 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 156,872评论 0 347
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,415评论 1 283
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,453评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,784评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,927评论 3 406
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,691评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,137评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,472评论 2 326
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,622评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,289评论 4 329
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,887评论 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,741评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,977评论 1 265
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,316评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,490评论 2 348

推荐阅读更多精彩内容

  • 用到的组件 1、通过CocoaPods安装 2、第三方类库安装 3、第三方服务 友盟社会化分享组件 友盟用户反馈 ...
    SunnyLeong阅读 14,604评论 1 180
  • 关于Markdown 一整个学期下来,我觉得让我收获最大之一的是学会markdown语言。我们平常都是使用Word...
    Dacade阅读 934评论 0 2
  • 辛弃疾至友陈亮,四次科举不仕,一届寒士,日日闻鸡起舞,期盼报国,五十岁时,一举中了状元,回乡整装待发,却一病而逝。...
    小妇阿达阅读 375评论 1 3
  • 一、异常处理机制1、异常的祖先是Throwable,有如下两个子类:a、Error:表示错误,错误产生后程序员不能...
    坚持也是一种成功阅读 826评论 3 27
  • 秋山利辉在《匠人精神》一书中,阐释了三十条通往一流匠人所需要在心理抱持的“信条”。读完感觉,三十条有所重复,遂重新...
    树先生1988阅读 479评论 0 1