Markdown教程(未完成)
一、Markdown的介绍
Markdown于 2004 年创建,是一种轻量级的标记语言,可用于在纯文本文档中添加格式化元素。
1、学习Markdown的原因
- Markdown 无处不在。StackOverflow、CSDN、掘金、简书、GitBook、有道云笔记、V2EX、光谷社区、主流的代码托管平台,如 GitHub、GitLab、BitBucket、Coding、Gitee 等等,都支持 Markdown 语法,很多开源项目的 README、开发文档、帮助文档、Wiki 等都用 Markdown 写作。
- Markdown 是纯文本可移植的。
- Markdown 是独立于平台的。
- Markdown 能适应未来的变化。即使应用程序将来会在某个时候不能使用了,仍然可以使用文本编辑器读取 Markdown 格式的文本。当涉及需要无限期保存的书籍、大学论文和其他里程碑式的文件时,这是一个重要的考虑因素。
2、Markdown 的优点
- 专注于文字内容。
- 纯文本,易读易写,可以方便地纳入版本控制。
- 语法简单,没有什么学习成本,能轻松在码字的同时做出美观大方的排版。
3、Markdown 的工作原理
在使用 Markdown 格式书写时,文本内容存储在扩展名为 .md 或 .markdown 的 纯文本文件 中。用 Markdown 应用程序 打开此文件并使用 Markdown 处理器(也称为“解析器”或“实现”)将Markdown 格式的文本转换为 HTML文档,以便在 Web 浏览器中查看显示。
二、Markdown的使用场景
1、练习方式
不需要下载任何程序,可以使用 在线Markdown编辑器 编写练习。
它将上述过程组合到一个界面中,你要做的就是在左窗格中键入内容,然后转换结果就会在右窗格中出现。以下是在线Markdown编辑器的页面展示。
2、尝试练习
一个开源网站,你能用浏览器在这个网站上尝试 Markdown:Markdown Tutorial
3、一些其他的使用场景
创建网站内容、简单的文件资料,记笔记,编写 小说,演示文稿、写邮件、技术文档。过多不赘述,以下展示相关性较强或者可能会用到的。
- 记笔记:可以使用Notable和Simplenote,或者我目前编辑此文档时使用的语雀。
- 演示文稿:基于浏览器的、流行的 Markdown 幻灯片工具,可以使用Remark(GitHub 仓库)和 Cleaver(GitHub 仓库)。
- 技术文档:如果是为产品或服务编写文档,请可以尝试VuePress,它是基于 Vue 构建的静态站点生成器,并针对编写技术文档进行了优化。
事实上,各个Markdown应用程序都有略微不同的Markdown语法。所幸对于公认的一些标准语法,各平台都是支持的。
三、Markdown 语法表
Markdown 语法表提供了所有 Markdown 语法元素的基本解释。
其中基本语法是 John Gruber 的原始设计文档中列出的元素,所有 Markdown 应用程序都支持这些元素;扩展语法通过元素添加额外的功能扩展了基本语法,但是并非所有 Markdown 应用程序都支持这些元素。
基本语法
元素 | Markdown语法 |
---|---|
标题 | (Heading) |
粗体(Blod) | **+ 文本+ **+ space |
斜体 (Italic) *+ 文本+ *+ space | |
引用块(Blockquote) >+ space+ 文本 | |
有序列表(ordered List) 1+ .+ space+ 文本 | |
2+ .+ space+ 文本 | |
3+ .+ space + 文本 | |
无序列表(Unordered List) -+ space+ 文本 | |
-+ space+ 文本 | |
-+ space+ 文本 | |
行内代码(Code) + 文本 + + space |
|
分隔线(Horizontal Rule) -+ -+ -+ space | |
链接(Link) [+ 链接标题+ ]+ (+ 链接内容+ ) | |
例:[title](https:// www.example.com) | |
图片(lmage) [title](https : / / www.example.com) | |
提示:“ ` ”这个符号的打出方式是 大写锁定+~。 | |
扩展语法 | |
元素 Markdown语法 | |
[ ] 未完成任务列表 [+ ]+ space+ 文本 | |
[X] 已完成任务列表 [+ x+ ]+ space+ 文本 | |
代码块 + + `+ 回车 |
|
删除线 ~~+ 文本+ ~~+ space | |
上标 ^+ 文本+ ^+ space | |
下标 ~+ 文本+ ~+ space | |
高亮 ==+ 文本+ ==+ space | |
创建表格 | + 文本+ |
提示;Markdown文本编辑器中是不需要出现如上的空格的 |
四、参考资源:
1、Markdown入门基础
https://markdown.com.cn/cheat-sheet.html