群分享:关于Markdown,你可能想知道的

写在最前面的话

本文参考了很多大神的 Markdown 入门教程,旨在推广,不标原创。所引部分参考文献列于文末,如有疏漏,还请海涵。

文中介绍的 Markdown 语法为最常用的基础语法,每种标签的语法表达不止一种方式,这里只选用了最常用的一两种,更多语法格式请参考文末给出的官方文档链接内容。

本文用Markdown完成,想看 Markdown 源文件的小伙伴请在后台回复「Markdown源文件」获取网盘下载链接。这是一篇小白科普文,有 HTML 基础的都自己去看 Markdown 官方文档,别在这儿秀优越感。

认识 Markdown

小幻比较懒,这里直接引用一下其他大神的说法。

Markdown是Aaron Swartz 跟John Gruber共同设计的一种轻量级「标记语言」。Markdown 的理念是,让文档更容易读、写和随意改。它用简洁的语法代替排版,而不像一般我们用的字处理软件 Word 或 Pages 有大量的排版、字体设置。它使我们专心于码字,用「标记」语法,来代替常见的排版格式。

Markdown 的输出格式比较自由,可以是 HTML ,可以是 PDF 文件,有些编辑工具甚至提供了Word文件格式。这样自由的输出仅次于 LaTex ,而 Markdown 相对于 LaTex 的一大优点是,Markdown 是一门 5 分钟就能够学会的标记语言。LaTex需要多久,小幻不知道,因为小幻到现在都没学会。

我们为什么要用 Markdown

1. 避免编辑疯掉

如果你有过给他人文档排版的经验,尤其是那种把多个人的文档进行整合排版的经验,你一定明白这个标题的意思。使用富文本(可以理解为带格式的文本)编辑器得到的文档,在合并时,会出现很多排版上的问题。一一解决这些问题,十分费神。而这种问题,并不是大家使用统一的文字处理软件例如 Word 就可以解决的,因为Word本身的版本差异,也会产生兼容性问题。

这也是小幻会介绍 Markdown 的最初原因,我们的分享群每月都会进行一次文章汇总,几十个人的文章分别发布在不同的平台上,汇总起来十分繁琐。即使每个人都将自己的文章按照模板整合进 Word 文档中,最后的汇总者仍然面临着大量的排版调整工作。

由于 Markdown 本身就是 txt,任何人都可以打开它,并且因为它只是带标记的纯文本,本身不带样式,因此不会因为版本问题而产生很严重的样式兼容性问题。其次,Markdown 向 HTML 或者 PDF 转换十分便捷。以上两个特点,使得 Markdown 在网络文字编辑方面十分占优势。

Markdown提供一个标准化的格式,让在线文本传播更简便。

2. 更加专注于写作内容本身

Markdown 只是标记语言,当它转换为 HTML 时,控制排版的是 CSS 样式文件,同样的 Markdown 文本配上不同的 CSS 样式,会展现出不同的 HTML 排版风格。网上有大量的基于 Markdown 排版的CSS样式文件,我们找到自己喜欢的即可,不用自己去写。因此对于写作者来说,使用Markdown的好处比起其他格式来说,更能专注在写作本身,将投入在排版上的精力节省下来,投入在写作本身,提高写作效率和创作体验。

阳志平在《Markdown写作浅谈》时说到:

  • 难以专心:写Word文档的时候,我们经常浪费大量时间在Word本身上,特别是那80%我们用不到的功能。比如,找借口,Word又出问题了;或者,又要升级了。其实,在内心偷笑,哈哈,可以偷懒了
  • 浪费力气在排版上:使用Word时,我们会花费大量力气去排版,试图让文档变得漂亮一些。是粗体还是斜体,是宋体还是黑体,对创作来说,有那么重要吗?
  • 难以自动的版本跟踪:每一位自杀的写作者的电脑文档里面,都必然有一个Word文档,从V1.0到V20.0的无数版本(如何优雅地进行版本追踪对于文科生来说,是一项进阶技能);
  • 难以共同协作:想想你让一位合作的编辑帮你改书有多么痛苦,一个Word文档来,一个Word去,极其难用的修订与审阅功能,你就理解了(此条适用于会批阅你文档的任何人,口头批阅不算);

Markdown帮助写作者提高写作效率,优化写作体验

Markdown 基本语法

Markdown 简单在于,掌握几项基本用法就可以顺利的完成写作任务,以下是几乎所有介绍 Markdown 入门的文章都会提到的几项基本语法。

  • 标题
  • 段落
  • 加粗
  • 斜体
  • 块引用
  • 链接
  • 图片
  • 列表
  • 分割线

标题

在标题行的最前面加上#号(英文半角字符,后面提到的所有符号都为英文半角),几个#号代表几个标题,最多可以到6级标题。部分编辑器会在标题文字前后都加上数量相等的#,效果是一样的。以下是样例:

标题1

标题2

标题3

标题4

标题5
标题6

源码:

# 标题1

## 标题2

### 标题3

#### 标题4

##### 标题5

###### 标题6

段落

在希望分段的地方空一行,即为分段。两段之间没有空行不会分段,这个不举例,自己试一下就好。

加粗

在希望加粗的文字前后加上**或者__效果相同,选用自己顺手的符号即可。

这里需要用粗体强调

这里需要用**粗体强调**。

斜体

在需要使用斜体的文字前后加上*或者_

粗体是两个星号,斜体是一个星号。

**粗体**是两个星号,*斜体*是一个星号。

块引用

在引用文字的第一行最前面加上一个>(像不像一个指示箭头?),整段文字都会以缩进形式显示

例如:

Markdown是Aaron Swartz 跟John Gruber共同设计的一种轻量级「标记语言」。Markdown 的理念是,让文档更容易读、写和随意改。

> Markdown是Aaron Swartz 跟John Gruber共同设计的一种轻量级**「标记语言」**。Markdown 的理念是,让文档更容易读、写和随意改。

链接

在你想要加链接的文字前后用中括号[ ], 然后紧接着加上URL网址链接,前后用小括号括住。

例如:

群分享:避开时间黑洞的小策略

[群分享:避开时间黑洞的小策略](http://mp.weixin.qq.com/s?__biz=MzI1MDQwOTU2OA==&mid=2247484421&idx=1&sn=5acc4da388942475cc103194e18aaf8d&chksm=e983e30adef46a1c2ab8a13861ddc81a7f598b78c778de1720b1803db59aa3857e8a0449dc7e&scene=21#wechat_redirect)

备注:这一条对于写公众号的朋友有点儿难弄,因为微信严格限制个人订阅号的链接引用。所以打算在公众号里使用Markdown的各位,知道有这么回事儿就行,链接还是需要自己手动添加的。

图片

添加图片跟添加链接的方法差不多,格式是![图片名](图片超链接),图片要求提前上传到公网可以访问的空间,很多支持Markdown的在线编辑器会帮助作者通过可视化操作上传图片,就容易很多。

(这张图片是小幻的公众号图片)

Markdown插入图片源码

![Follow](http://t.cn/RJ8yzcq)

备注:图片里是小幻打算给小组伙伴做的分享课,本文里没看明白的地方,可以去微课里提问。

列表

Markdown里只有两种列表,有序列表与无序列表。有序列表每行前面是数字序号,无需列表是一个小符号。

有序列表是以(数字 + . + 空格)的格式来标记的,但是不需要数字有顺序,甚至一样也没关系。无序列表可以使用星号,加号或者减号(*、+、-)创建,它们三者效果都是一样的,但要注意符号与列表内容之间需要加空格。

有序列表示例

  1. 跟着小幻GTD:收集阶段-日常收集 | 时间管理
  2. 跟着小幻GTD:收集阶段-归拢材料 | 时间管理
  3. 跟着小幻GTD:Newbie,你准备好了吗? | 时间管理
  4. 跟着小幻GTD:如何成为一只 GTD newbie| 时间管理

1. 跟着小幻GTD:收集阶段-日常收集 | 时间管理 1. 跟着小幻GTD:收集阶段-归拢材料 | 时间管理 1. 跟着小幻GTD:Newbie,你准备好了吗? | 时间管理 1. 跟着小幻GTD:如何成为一只 GTD newbie| 时间管理

无序列表示例

  • 跟着小幻GTD:检查回顾-保障系统的有效运行 | 时间管理
  • 跟着小幻GTD:组织整理-建立好清单 | 时间管理
  • 跟着小幻GTD:处理阶段-清空工作篮 | 时间管理

* 跟着小幻GTD:检查回顾-保障系统的有效运行 | 时间管理 * 跟着小幻GTD:组织整理-建立好清单 | 时间管理 * 跟着小幻GTD:处理阶段-清空工作篮 | 时间管理

分割线

要添加分割线非常简单,直接在一个空行里打上三个星号(***)或者三个下划线(___)。

例如:


***


___

Markdown 编辑器

Markdown 编辑器有很多,以下推荐几款使用比较广泛的软件。

  • Mac平台:
    • Mou (开源项目,目前似乎已停止维护?)
    • MacDown(MacDown由开源项目Mou修改而来,这篇文章就是用MacDown写的)
    • ulysses(广受好评的工具,但是收费,小幻买不起反正)
  • Windows平台:推荐MarkdownPad(Win10系统使用时会遇到不能即时显示 HTML 预览的问题,安装组件可解决)
  • Web平台:
    • 简书(支持Markdown)
    • Wordpress(通过安装插件支持Markdown)
    • typora(全平台,这个是被推荐的,小幻自己没用过)
  • RStudio可作为写作科技论文与R语言编辑器选择,它是跨平台的
  • markdown-here借助Chrome插件,将gmai写作窗口变为Markdown在线写作窗口
  • 可以直接在线通过github撰写与提交Markdown文件,github有自动的版本跟踪功能,不用担心写废与找不到以前写的

Markdown 进阶

这里只讲一下进阶的 Markdown 可以做什么,其他的留待未来某天分享。

  1. Markdown + GitHub(或者其他版本管理工具)解决文档共享与版本自动跟踪问题
  2. Markdown + R 解决科学文档写作问题(可重现性,跨平台性,支持LaTex公式)
  3. 更多的 Markdown 写作技巧,参看阳志平的《Markdown写作浅谈》

参考文献

这里给出Markdown语法的官方文档以及链接,其中,中文文档的末尾还附带了各个平台的免费工具介绍

  1. 创始人 John Gruber 的 Markdown 语法说明
  2. Markdown 中文版语法说明
  3. Markdown 写作浅谈
  4. Markdown 在线写作速成
  5. 认识与入门Markdown

链接地址

[1]: http://daringfireball.net/projects/markdown/syntax

[2]: http://daringfireball.net/projects/markdown/syntax

[3]: http://www.yangzhiping.com/tech/r-markdown-knitr.html

[4]: http://joinwee.com/lesson/10

[5]: http://sspai.com/25137

--- END ---

原文发布于微信公众号 - 申龙斌的程序人生(slbGTD)

原文发表时间:2017-02-23

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏架构师之路

im协议设计选型(上)

im协议设计选型(上) 周末在一个Qcon群里分享了一些im技术,抽取出其中im协议选型相关的内容,跟大家分享。 分享人:58沈剑,58同城技术委员会主席,高级...

35510
来自专栏FreeBuf

逆向华为路由器第三部分

引文 在前面两个部分(1,2)已经介绍了UART,BusyBox等部分的逆向调试,而这篇将会开始在流量分析方面下手,来逆向出更多的信息。 正文 请看下图,数据存...

1868
来自专栏H2Cloud

游戏服务器设计之NPC系统

游戏服务器设计之NPC系统 简介 NPC系统是游戏中非常重要的系统,设计的好坏很大程度上影响游戏的体验。NPC在游戏中有如下作用: 引导玩家体验游戏内容,一般游...

3314
来自专栏数据小魔方

是时候展现真正的技术了——让你的图表舞动起来~

最近更新的频率越来越少了,因为我个人原因,各种事情在忙,实在对不起大家,今天写一篇补偿一下~ 既然写的少了,那么以后每写一篇,都会让技术含量高一些,这样才能对得...

3007
来自专栏FreeBuf

利用USB橡皮鸭在目标机器上启动Empire或Meterpreter会话

今天我将教大家如何使用Rubber Ducky在渗透中建立Empire或Meterpreter会话连接。然而对于Ducky而言,想要完成大多数现实场景中的USB...

3457
来自专栏技术博文

DiscuzX2.5数据库字典

pre_common_admincp_cmenu – 后台菜单收藏表 title => ‘菜单名称’ url => ‘菜单地址’ sort => ’0′ COM...

2807
来自专栏java一日一条

Mac下提升工作效率的方式

Mac 系统一向以提供高效的工作环境著称,iOS、Android和服务端程序员都可以轻松的在Mac上搭建舒适的开发环境。笔者主要从事iOS开发,一般在macbo...

783
来自专栏Crossin的编程教室

【Python 第4课】输入

Hi~Crossin又来了。 可以用编程语言让计算机按你说的指令做事情之后,大家是不是有些跃跃欲试呢?别着急,先回顾一下我们之前几节课。我们到现在一共提到了三种...

2827
来自专栏BestSDK

20个对前端开发人员有用的文档和指南

是时候来更新一下我们需要选择的工具或技术了。请欣赏我们的文档和指南系列的第五部,别忘了让我们知道任何其他我们尚未列入该系列的其他文档或指南。 1.SitePoi...

2307
来自专栏DevOps时代的专栏

网站性能测试利器:Puppeteer

? 译者:CK星空,本文由 DevOps 时代高翻院翻译整理发布 网站性能测试从来没有像今天这么重要。测试的工具有Lighthouse,WebPagetes...

61512

扫码关注云+社区