LOADING
658 words
3 minutes
写作语法速查:Markdown 与扩展语法实战

这篇文章是本博客支持的全部写作语法的实战演示:每个语法先展示源码,紧接着就是渲染出来的真实效果。忘记语法时回来翻这篇即可。

一、Markdown 基础语法

1. 文字样式

写法:

**加粗** *斜体* ~~删除线~~ `行内代码`

效果:

加粗 斜体 删除线 行内代码

2. 列表

写法:

- 无序列表项
- 第二项
- 缩进两个空格变成子项
1. 有序列表第一项
2. 第二项

效果:

  • 无序列表项
  • 第二项
    • 缩进两个空格变成子项
  1. 有序列表第一项
  2. 第二项

3. 引用与链接

写法:

> 这是一段引用。
[链接文字](https://github.com/Tangq-git/Twilight)

效果:

这是一段引用。

链接文字

4. 代码块

写法:三个反引号开头并标注语言,三个反引号结尾。

效果:

public class Hello {
public static void main(String[] args) {
System.out.println("Hello, Blog!");
}
}

5. 表格

写法:

| 姓名 | 语言 | 方向 |
| --- | --- | --- |
| Tangq | Java | 后端 |

效果:

姓名语言方向
TangqJava后端

二、扩展语法(本主题专属)

1. GitHub 仓库卡片

写法:

::github{repo="Tangq-git/Twilight"}

效果:

Tangq-git
/
Twilight
Waiting for api.github.com...
00K
0K
0K
Waiting...

2. 提示框(Admonitions)

通用写法::::类型 开始,::: 结束,中间写内容。一共五种类型,效果如下:

Note

note:普通备注,用来补充说明。

Tip

tip:小技巧。比如:写作时把 pnpm dev 开着,保存即可实时预览。

Important

important:重要信息,希望读者一定看到的内容。

Warning

warning:警告。比如:影评写到这里可能涉及轻微剧透。

Caution

caution:危险操作提醒,比如「执行前请先备份」。

3. 隐藏文本(Spoiler)

写法:

:spoiler[被隐藏的文字]

效果:这句话里藏了一个 小彩蛋,点我就显示。

适合放剧透、谜底、答案。

三、Frontmatter:文章的「身份证」

每篇文章文件开头的 --- 之间是元信息,本篇文章的是:

---
title: 写作语法速查:Markdown 与扩展语法实战
published: 2026-11-01
description: 列表页显示的摘要
category: 博客使用教程合集
tags: [博客教程, Markdown]
---

常用字段速查:

字段作用必填
title文章标题是
published发布日期,决定排序是
description列表页摘要否
cover封面图路径否
category分类(侧栏 Categories)否
tags标签,可多个否
draft设为 true 就是草稿,不会发布否
pinned设为 true 在列表置顶否

四、小技巧

Tip

文章放进 posts/ 下的子文件夹,侧栏「Directory」会自动按文件夹分组。本篇文章就在「博客使用教程合集」文件夹里。

写完保存 → 本地 pnpm dev 实时预览 → 满意后 commit + push,Vercel 会自动部署上线。

写作语法速查:Markdown 与扩展语法实战
/posts/博客使用教程合集/01-写作语法速查/
Author
Tangq
Published at
2026-11-01
License
CC BY-NC-SA 4.0

Some information may be outdated

Directory
Albums
Diary
Posts
Projects
Skills
Timeline
Categories
Tags
Table of Contents