Appearance
markdown
元信息
- 目标:在 HTML(Markup)的对照下理解 Markdown(down)的定位——面向人类书写的轻量标记语言,经渲染器转换为 HTML 等格式;掌握其组成(语法/转译工具/编辑器)与 frontmatter 元数据
- 关键概念:轻量标记语言、Markdown、渲染器、frontmatter、方言(GFM)、markdown-it
- 关联阶段:cp1
- 常见误区:以为 Markdown 是 HTML 的替代品(它是书写层,最终仍转译为 markup);以为 Markdown 语法全世界统一(GFM 等方言众多,借 markdown-it 可自编方言);把 frontmatter 当正文(它是给处理软件读的元数据,类似 HTML 的 head)
什么是markdown?
Markdown 是一种轻量级标记语言,创始人为约翰·格鲁伯(John Gruber)。它允许人们“使用易读易写的纯文本格式编写文档,然后转换成有效的HTML(或者其它标记语言)文档”
Markdown与Markup正好相反,它是对人类友好,方便人类书写,但同时又可以自动转换为各种markup格式
它一般由Markdown语法、Markdown转译工具、Markdown编辑器等组成
优点
- markdown完全从语义出发
- markdown是方便人类使用的一种书写语言,比之于html markup写起来更简洁和易记,更适用于人类的书写,故名: markdown
- markdown的特点是用简单、适合人性的标记,能够在方便输入文本的同时,清晰的刻画了文本的结构
- 使用markdown渲染器,可以将markdown文本转换为各种格式,包括HTML、PDF等
- markdown由于其人类亲和性,还是LLM喜欢的输入输出格式,成了AI时代的宠儿
frontmatter
frontmatter 位于markdown文件的顶部,类似于html的<head>区域,是关于markdown文档的元数据或说明,便于markdown处理软件进行处理,由多个 key-value 对的结构化数据组成,示例如下:
markdown
---
title: 我的文档标题
author: 张三
date: 2024-01-15
---
# 我的文档标题
这里是文档的正文内容...更多 https://www.markdownlang.com/zh/advanced/frontmatter.html
github方言语法
- 由 github.com 对基本markdown语法进行了扩展,是当前最流行的markdown方言
- GitHub Flavored Markdown https://help.github.com/categories/writing-on-github/
- 借助markdown书写系统开发工具,如markdown-it,可以自编任何markdown方言
桌面编辑器
- Windows MarkdownPad http://markdownpad.com
- Mac http://mouapp.com/
- linux remarkable
扩展
- onenote支持markdown https://www.appinn.com/onemark-for-windows-onenote/
- markmap 将markdown变成mindmap https://github.com/markmap/markmap