Skip to content

checkming/MarkDown-

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 

Repository files navigation

1. 为什么大多数的程序员们都使用MarkDown文档编译器?

Markown 从入门到精通

大部分作家用 Word 或 Pages 写作,过去的文档也大都以 .doc, .docx 格式或是 Pages 格式储存。还有人为了保证文稿发给谁都能正常打开,会用 .txt 格式。如果需要格外对内容进行标记或者展示的明显的标记效果却是无可施展,而且.doc 或Pages 格式有如下的问题:

1.不一定谁都能打开。用 Windows 的人打不开 .pages 文件,用旧版 Word 的人不一定能打开你用新版 Word 写的稿子。

2.对方看到的稿子的样子和你自己看到的可能差别很大。

3.Office 已经是你电脑上唯一的盗版软件,导致心情不佳。

.txt 的问题就很明显咯,文字的普遍性,无法突出关键笔记模块,格式的问题在于没有样式:收到稿子的编辑和设计师可能不知道哪个是小标题,哪里需要斜体,哪里需要加粗都无法得知.

所以咯,接下来就是MarkDown上场的时候咯,这也就是这款编译器被众多网络作家,程序员们(自己也一直使用o( ̄▽ ̄)d)

在 Markdown 的语法里,两个井号(##)代表二级标题。若你要告诉编辑或设计师某句话是小标题,只要在标题前加入两个井号即可。若该小标题下还有其它小标题(三级标题),只要在三级标题前加上三个井号即可。从打字量上讲,两个井号只需要按两次键,「(小标题)」的按键次数多了一倍不止。从易读性上讲,「(小标题)」是自然语言,容易跟稿件正文混淆,## 则清晰得多。

顺便附上一张MarkDown 书写预览图 手写预览图

2 .MarkDown 的好处

1.无门槛低成本,可以快速上手。 减少鼠标使用,几乎纯键盘操作。 关心文字内容,忘掉格式干扰。 没错,最主要是——装逼!

2.兼顾了「什么人都能打开」和「样式」Markdown 就是纯文本,就是 txt,所以什么人都能打开。而如上所述,你可以用它来标记文本的样式,而且语法非常简单。

3.Markdown 转 HTML 非常方便。HTML 是整个万维网(web)的标记语言,但更重要的是,它也是目前主流电子书格式所用的标记语言。无论是 EPUB, mobi,还是 Kindle 用的专有格式 .azw,都只是把一堆 HTML 文件打包而已。如果你写的是书,用 Markdown 标注格式之后,可以很方便地转为以上格式(当然这个转换工作不需要由你来做);如果你写的是单篇的文章(例如新闻报道或专栏),未来也不排除结集出书的可能。若采用 Markdown,对于日后的文件转换工作也大有裨益。

4.Markdown 语法记忆负担再小,也是一种负担,在初学者书写 Markdown 的过程中,编辑器需要适当给予提示,例如:语法高亮。书写 # 的时候可以加粗文字以表示标题,等等。

5.对于被 office 系惯坏的初学者,他们在学习之初可能对工具栏更有代入感,再简单的语法也可能遗忘,但是点击一下粗体的图标谁都会,所以不妨提供一个工具栏给他们,起码忘记语法的时候可以通过工具栏了解到粗体效果的语法应该是怎样的, 久而久之,在切身体会到键盘和工具栏效率上的差异性以后,用户自然会只记得语法,反而嫌工具栏多余。这个时候适时提供隐藏工具栏的按钮。

6.向初学者展示完整的语法列表以及对应的渲染效果。需要教程作者首先了解大部分的 Markdown 语法,然后一一介绍,介绍的文字不必繁琐,点到为止,重点是有一个左右两屏可以互相参照的系统,例如:左边是 Markdown 的原始文稿,右边是相应的渲染效果, 两屏之间实时渲染。这样读者很容易知道什么样的标记对应什么样的渲染效果,初学者可以自己大胆地修改 Markdown 的内容,实时观察相应的渲染变更。

3 .Markdown语法
Markdown语法的目标是:成为一种适用于网络的书写语言。

3.1 语法属性 动手之前,先看看语法属性。

英文输入法:Markdown语法的标记符号(语法标记)必须为英文输入。 作用域:作用域是一条语法标记的作用范围,常见为:行、段、区间。 行:回车换行(行以回车结尾)。 段:与以往回车换行另起一段的经验不同,段落之间由空行隔开(段以空行结尾)。 区间:有些语法标记与( )一样,是成对儿出现的,如: 、* 等,它们的作用域是符号所包围起来的一个区间。在if(true);中,作用域为if(true);。 注:区间可以是一行中的一部分,也可以是一段中的某几行,但是不可以跨越段落,也就是区间中不能存在空行。 语法位置:位置是相对于作用域而言的,常见为:前置、后置,端置。特定的符号只有在恰当的位置,以恰当的格式出现才被认为是语法标记,否则识别为普通字符。 前置:语法标记写在作用域之前。 后置:语法标记写在作用域之后。 端置:语法标记写在作用域两端。 语法方向:方向和位置对应,一般前置语法为后向、后置语法为前向、端置语法对向。 前向:语法标记对紧接其前的作用域有效 后向:语法标记对紧随其后的作用域有效。 对向:语法标记对其包围的区间有效。 3.2 常用语法 3.2.1 标题 语法标记:#(#号+空格) 作用域:行 语法位置:前置(同行前置,写在目标文字开头) 语法方向:后向 好用等级:(5颗星) 解说*:#支持6个级别的标题,#号的数量代表标题的级别。 图片

语法标记:=、-(等号、减号) 作用域:行 语法位置:后置(写在目标文字下方,类似给文字加底线) 语法方向:前向(对前一行内容有效) 好用等级:(2颗星) 解说:=、-支持2个级别的标题,=标记一级标题,-标记二级标题。原则上符号数量不限,但各编辑器支持方式略有差异。 后置语法在Markdown中并不常用,所以,这种标记方式了解即可。

3.2.2 分割线 语法标记:、---、___(3个星号、减号、底线) 作用域:行(空行) 语法位置:前置(写在空行行首) 语法方向:后向 好用等级:(4颗星) 解说:、---或___将一个空行标记为分割线,一般分割线前后也会各留一个空行。 华丽的分割线是部分写手的钟爱,不用也无损大雅,各取所需吧。

3.2.3 列表 标记符号(有序列表):1.(序号数字+点号+空格) 标记符号(无序列表):*、+、-(注意空格符号后面有空格) 作用域:行 语法位置:前置 语法方向:后向 好用等级:(5颗星) 解说:列表有有序和无序之分。 --有序列表,在逻辑顺序上具有先后关系。 --无序列表,条目之间只做横向比较或罗列。 另,结合Tab缩进可实现列表的嵌套,比如在一个条目下还有3个子条目,则3个子条目仍然可以写成低一级别的列表。 合理运用列表,文章逻辑条理更清晰,结构层次更分明。

3.2.4 引用 标记符号:>(大于号+空格) 作用域:段 语法位置:前置(添加在段首,第一行之前) 语法方向:后向 好用等级:(5颗星) 解说:在需要引用的段落前加上'>'和空格,如:> 光明源于黑暗,黑暗涌现光明。 引用也可以嵌套。 另外,也有同学给标题添加引用标记,展现效果同样出色。

3.2.5 链接 语法符号:([ ]中放锚文本,()中放链接地址) 如: 简书 作用域:区间(锚文本) 语法位置:端置 语法方向:对向 好用等级:(4颗星) 解说:根据不同使用场景,文字链接有内联和引用两种方式。 --内联方式,满足一般使用需求,直观方便,即用即写。 --引用方式,适合添加多个网址的文章,可以避免在正文中出现大量网址,保持编辑可读性;也适合同一网址多处引用,当网址有改动或修改时,只需修改列表即可,无需逐个修改,类似宏定义。

3.2.6 图片 语法符号:([ ]中放图片说明,()中放图片链接) 如: 作用域:无(插入性语法,无作用域) 语法位置:不限 语法方向:无(插入性语法,无方向性) 好用等级:(3颗星) 解说:江湖传言“字不如表,表不如图”、“一图胜千文”、“无图无真相”云云,图片重要性不言自寓,然而缺少好的图床,完美的语法没有完美的解决方案,一样是没有什么卵用。 当然,在简书上写作非常省心,图片处理就是直接拖进编辑区,这一点真的很贴心。 与文字链相同,图片也有内联和引用两种方式。

3.2.7 强调 语法标记:* 、_ _(星号对或底线对) 作用域:区间 语法位置:端置 语法方向:对向 好用等级:(4颗星) 解说:强调有3种形式,分别为:单星对 斜体强调、双星对* 加粗强调、三星对* ***斜体加粗强调。

3.2.8 脚注 语法标记:[^1]+[^1]:注释内容([^1]是角标,[^1]:注释内容是对应的注释列表,必须一一对应) 作用域:无(插入性语法,无作用域) 语法位置:注释点(一般插入在需注释词汇的后面) 语法方向:无(插入性语法,无方向性) 好用等级:(4颗星) 解说:写文章时,不可避免要用到读者陌生的词汇或典故,就地解释会把文风带偏,不作说明显然治学不严,脚注为此而生。

3.2.9 代码 语法标记: (Tab缩进或连续空格)、 号对,注:号俗称“小句号”,和波浪号在同一按键上) 作用域:行 语法位置:空格或缩进为前置、号对为端置 语法方向:空格或缩进为后向、号对为对向 好用等级:(3颗星) 解说:对程序猿(媛)同学来说,要在文章中插入一段代码,怎么办? --代码行:单`号对可以实现代码行效果; cout<'hello><> 代码区:Tab缩进或连续空格,实现代码区块的效果(注意代码区要独立成段,且每行都要缩进)。

3.2.10 表格 语法标记:|和-和:组合 作用域:段、区间 语法位置:组合型 语法方向:组合型 好用等级:(1颗星) 解说:表格在Markdown语法中真是个鸡肋,如果非用不可倒也无妨。 --|和|之间形成单元格。 --第一行为表头,内容默认加粗居中。 --第二行-和:组合,标记本列单元格对齐方式。无:号,为默认左对齐;两端:为居中;左、右其中一端:向该侧对齐。 --其余行为普通单元格。 注意:(1)第二行不可省略,否则语法不完整;(2)表格必须为整段,中间不能有空行。 | 表头 | 表头 | 表头 | | ------- |:-------:| -----: || 11 |12 |13 || 21 |22 |23 || 31 |32 |33 || 41 |42 |43 |

About

MarkDown 编译器的基本使用教导

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors