Markdown 能写出什么:一份完整的语法清单
这篇文章本身就是一份测试数据:它把常用的 Markdown 语法全部用了一遍。如果你正在搭建自己的博客,可以直接把它抄走当渲染自测页。
行内元素
一段文字里可以有加粗、斜体、行内代码,以及一个链接。中英文混排的时候注意在两者之间留一个空格,比如 React 和 Vue,读起来会舒服很多。
列表
无序列表:
- 界面安静,注意力才能落在文字上
- 深色模式不是反色,是另一套配色
- 中文正文的行高要比英文松
有序列表:
- 写作
- 渲染
- 发布
任务列表:
- 搭好博客骨架
- 接入标签与搜索
- 添加 RSS 订阅
引用
写作是为了思考,发布是为了确认自己思考过。
这句话是我自己说的,未必对。
代码块
一段 TypeScript:
interface Post {
slug: string;
title: string;
tags: string[];
}
function hasTag(post: Post, tag: string): boolean {
return post.tags.includes(tag);
}
一段 shell:
npm run dev
# 然后打开 http://localhost:3000
一段没有标注语言的代码,同样应该被善待:
Plain text here
表格
| 语法 | 用途 | 备注 |
|---|---|---|
# | 标题 | 一篇文章只用一个一级标题 |
[]() | 链接 | 外链在新标签页打开 |
> | 引用 | 适合放金句,慎用 |
Mermaid 图表
技术文档里的流程图、时序图,直接写 mermaid 代码块,构建时渲染成静态 SVG(本地开发时同样即时可见):
时序图也没问题:
视频
B 站、YouTube 或 mp4 直链,单独一行贴地址即自动内嵌播放器,写法见《镰仓的一天》示例文。
图片
分割线
到这里,一份语法清单就用完了。日常写作大概只用到其中的一半,但另一半决定了文章在细节处体不体面。