本文面向不了解 markdown 或刚准备上手的同学。
它是什么
首先,什么是 markdown?我们可以直接看一下 WIKI……不过 wiki
很长,让人没有耐心读下去。那么,简单来说,markdown 其实是一种轻量级的标记语言;
或者说,它规定了一些文本的书写格式,就像这样:
写上你的标题 ============ 开始书写正文吧 当然也可以用 *列表* 的形式: * 列表项目 * 还是列表项目
上面这一段东西就是 markdown 了——它看上去和普通的文本没什么两样,只不过文字“被一些
标记 格式化”了,所以看上去会感觉比较漂亮,书面化一点形容叫做 具备更高的可读性
这一段 markdown 给我们的直观感受是我们能够清楚地识别出其中的“标题”、“段落”以及“列表”,
对,就和我们熟知的 html 一样,用来格式化内容
为何使用
接下来的问题自然是,我们为什么要使用 markdown?
我们可以把这个问题进一步拆分为三个问题:
- 使用 markdown 而不是 html 的好处在哪
- 在哪些场景下使用?
- 这个东西的普及度如何?(这意味着它的前途)
接下来一一回答:
-
前文已说,markdown 和 html 都是一路的标记语言,用来格式化内容。而内容之所以要显得很
格式化,是因为这样我们更容易阅读和理解。被渲染后的 html 是很可读的,但是 html 代码读起来
就很糟糕,因为它夹杂着大量<tag>
;而 markdown 不管是写还是读,都很舒服有一点需要注意的是,markdown 并不是为了取代 Html,因为根本取代不了。Markdown 的理念是,
能让文档更容易读、写和随意改。HTML 是一种发布的格式,Markdown 是一种书写的格式最后一点,markdown 可以被编译为 html,比如使用在线的 Pandoc
-
我个人认为,我们在 txt 上写的文档或随手记之类的东西,就完全可以使用 markdown,简单且美观
另外,最重要的一点,我们可以在 支持把 markdown 编译为 html 的地方书写 markdown,好处是
显而易见的:书写简单、展现美观。典型的场景有:github 仓库的 README 描述文件、github 中的
issue、评论框等。总而言之,把它用在要写文档的地方,妥妥的 -
我们知道,这世界上还有很多类似于 markdown 的轻量级标记语言,比如形形色色的 wiki 语法。所以,
我们凭什么使用 markdown 而不是 markup 或者 wikidown?答案很简单,因为它很流行。至少著名的程序员社区如 github 和 stackoverflow
都提供了对它的大量支持
说了那么多,结论就是,学习并且使用 markdown,必须的!何况 markdown 学起来非常简单
语法简要介绍
接下来会非常简单地介绍一下语法,而详细的语法大全可以直接去 作者的官网 查看。
作者对语法的介绍富有条理且细致入微。
语法介绍之后会着重说一下几个比较给力的特性,这个部分是重点
部分语法如下:
-
使用一个或多个空行分隔内容段来生成段落
<p>
。 -
标题(h1~h6)格式为使用相应个数的“#”作前缀,比如以下代码表示 h3:
### this is a level-3 header ###
-
使用“>”作为段落前缀来标识引用文字段落。这其实是 email 中标记引用文字的标准方式:
> 引用的内容 > 这个记号直接借鉴的邮件标准
-
使用“*”“+”“-”来表示无序列表;使用数字加“.”表示有序列表。如:
1. I am ordered list item 1... 2. So I should be item 2!?
-
使用 4 个以上 空格或 1 个以上 的 tab 来标记代码段落,它们将被
<pre>
和<code>
包裹,这意味着代码段内的字体会是 monospace
家族的,并且特殊符号不会被转义。 -
-
使用
[test](http://example.net "optional title")
来标记普通链接。 -
使用
![img](http://example.net/img.png "optional title")
来标记图片。
引号内的 title 文字是可选的,链接也可以使用相对路径。
-
-
使用 * 或 _ 包裹文本产生 strong 效果:
_语气很重的文本_ 以及 **语气更重的文本**
给力的特性
-
普通换行并不产生新的段落或
<br>
,但是产生空格。其实这个和 html 对 line-break 换行 的处理方式是一致的。为了使文本良好地展示在视野内,
我们会选择 手动地 将文字折行,但是并不意味着这两行在逻辑上不是一个段落。我们也可以插入真正的手动换行符
<br>
,如果要问<br>
在什么时候有用,下面是一个例子:我
其实
是一首
诗……楼上
这一段
说得漂亮! -
支持 setext-style 的 header 定义:
-
定义 h1:
THIS IS THE MAIN TITLE ======================
-
定义 h2:
This is the subtitle --------------------
更低级别的 header 就无法使用这种方式定义了。我们不用管 setext-style 是什么意思,只需要知道
这种标记方式更能凸显文章标题 -
-
在 blockquote(“>”标记的段落) 之内可以嵌套使用其他标签,甚至可以再嵌套
blockquote——上古神书《商古》写道: > 今有一鼎,镌以奇文: > > 吾乃鼎,非杯具也。
-
支持引用式的链接格式。什么叫做“引用式”的链接呢,举例来说,
对于本文中的一段文字,相应的 mkd 代码是:首先,什么是 markdown?我们可以直接看一下 [WIKI][1]…… 另外,markdown 可以被编译为 html,比如使用在线的 [Pandoc][2] [1]: http://en.wikipedia.org/wiki/Markdown "wiki_markdown" [2]: http://johnmacfarlane.net/pandoc/try "pandoc online"
看上去就好像是“引用文献”的格式一样。好处非常易见:
- 正文文本中不会出现 url 链接这种读者不关心的信息,从而不影响读者的阅读
- 链接地址可以当做一个变量,进行复用
-
支持快捷链接。一般来说,我们如果要显示一段 url 文本,最好也希望这个 url
本身能够点击。比如 http://ued.taobao.com如果使用 html,则要写作
<a rel="external nofollow" class="external" target="_blank" href="http://ued.taobao.com">http://ued.taobao.com</a>
包含了冗余信息且可读性很差,而在 mkd 中,只要写
<http://ued.taobao.com>
就 OK 了,非常方便。
结尾
以上便是对 markdown 的一个简要介绍了,需要了解进一步内容的,请移步
VIA http://ued.taobao.com/blog/2012/07/getting-started-with-markdown/
相关推荐
使用Markdown简短的README.md文件,介绍了如何开始使用Markdown(一种非常简单的网页标记语言)链接入门登录到GitHub。单击+添加一个新的仓库。输入回购的名称(将成为页面的标题)。允许GitHub根据项目类型创建....
初学者在刚开始使用Markdown语法时的借鉴例子,逐渐熟练后就可以自由放飞啦!!
最近,我开始使用Markdown在VS Code中记录编码笔记。 它使我可以专注于内容和代码,而不会因风格或语法突出显示而陷入困境。 我确定还有其他机制,但这对我有用。 由于注释的结果是一个文件或一组文件,因此您可以...
在编写md格式的内容时,以pre标签开始和结束即可。 例如: ## chrome插件测试 * 简单的hello,world package main import "fmt" func main(){ fmt.Println("hello,world") } </pre>
这是我准备开始使用 Markdown 通过 pandoc 编写我的博士论文的一小部分脚本/模板。要求/学分安装了python LaTeX 包 (或 BibLaTeX) 要写的论文:)如何将您的内容写入 Markdown 文件 (.md)。 编辑Makefile并运行make...
尽管此项目的markdown语法高度稍有不同,但也可以使用命令。目录1.1。 托克1.1.1。 等级1.1.2。 最低水平1.1.3。 编号1.1.4。 忽略1.2。 参考1.3。 包括1.4。 编号标题1.4.1。 等级1.4.2。 最低水平1.4.3。 跳过...
如何减价 了解如何开始使用Markdown。 有点奇怪,但是许多人仍然不知道Markdown,尽管这个惊人的工具并不难。 这位讲习班的人将教您如何使用Markdown。 Markdown是一种轻量级的标记语言,具有纯文本格式语法,旨在...
最开始markdown 模板(2019年1月6号完整的版本,就是那个刚开始打开有,后来就再也找不到的玩意)
先看 rmarkdown 包创始人谢大大的文档rmarkdown 包从版本 1.9 开始,编译 R Markdown 为 PDF 时会调用 tinytex,这样
您的GitHub学习实验室存储库,用于使用Markdown进行通信 欢迎你的资料库为您的GitHub学习实验室课程。 在我将指导您完成的各种活动中将使用该存储库。 哦! 我还没有自我介绍... 我是GitHub Learning Lab机器人,...
自2004年推出以来,数以百万计的人开始使用它来编写从便笺到文档的所有内容。它是有史以来最成功的标记语言之一。 Markdown在其他标记语言失败的地方取得了成功,因为它在功能和简单性之间取得了适当的平衡。它易于...
如何使用MarkDown写一篇博客 也工作了一段时间了,遇到了很多问题,很多时候费力的解决了一些问题,但是没有记录下来,过了一段时间遇到同样的问题还是要从头开始解决,因此准备开始记录自己遇到的一些坑,从学习markdown...
使用Java将markdown转换为pdf的简单库 ##为什么有时候,创建markdown文件的pdf版本可能会派上用场。 该库结合了其他几个库,以利用您自己转换所有内容的麻烦。 代码库保持很小,同时仍提供流畅的API。 ##先决条件...
-而其中,一切都开始它 - 添加缩写 - 添加锚点 - 添加定义列表 markdown-it-emoji - 添加表情符号 markdown-it-footnote - 添加脚注 markdown-it-highlightjs - 为代码块添加高亮 markdown-it-ins - 添加标签 ...
Nextcloud Markdown编辑器通过Markdown文件的实时预览扩展Nextcloud文本编辑用法从Nextcloud 17开始,“应用程序替换了“应用程序。 为了使用Markdown编辑器,必须安装并启用它和。 要使用Markdown编辑器,只需打开...
React降价编辑器精简版轻巧(压缩的20KB压缩)...editor-lite基本用法步骤如下: 导入react-markdown-editor-lite 根据需要注册插件初始化markdown解析器,例如markdown-it 开始使用// import react, react-markdown
降价档案关于Markdown Profiles是一个项目,可为需要真棒Github配置文件的人生成markdown文件,它提供了多个模板供您使用。目录发展建造部署贡献/报告问题执照 先决条件为了运行项目,需要满足以下要求: 吉特NodeJS...
先来个学习Markdown的文章, 要想学习一门语言还是要从"是什么"开始学起, 那么... ##Markdown是什么 Markdown 是一种轻量级标记语言,创始人为约翰·格鲁伯(John Gruber)。它允许人们“使用易读易写的纯文本格式...
注意:从2.0版开始,@ wq / markdown仅与渲染器兼容。 要与经典渲染器集成,请安装 原料药 默认情况下,@ wq / markdown在当前上下文中查找markdown属性。 如果存在,则包含的将使用和呈现Markdown。 @ wq / ...
Markdown Eclipse编辑器插件此插件已在Windows 7上使用Eclipse Indigo和Juno进行了测试。 使用Markdown解析器 。 安装说明下载jar(v1.0.1) 将其复制到Eclipse的dropins文件夹中。 重新开始蚀