Table of Contents
658 words
3 minutes
写作语法速查:Markdown 与扩展语法实战
这篇文章是本博客支持的全部写作语法的实战演示:每个语法先展示源码,紧接着就是渲染出来的真实效果。忘记语法时回来翻这篇即可。
一、Markdown 基础语法
1. 文字样式
写法:
1**加粗** *斜体* ~~删除线~~ `行内代码`效果:
加粗 斜体 删除线 行内代码
2. 列表
写法:
1- 无序列表项2- 第二项3 - 缩进两个空格变成子项4
51. 有序列表第一项62. 第二项效果:
- 无序列表项
- 第二项
- 缩进两个空格变成子项
- 有序列表第一项
- 第二项
3. 引用与链接
写法:
1> 这是一段引用。2
3[链接文字](https://github.com/Tangq-git/Twilight)效果:
这是一段引用。
4. 代码块
写法:三个反引号开头并标注语言,三个反引号结尾。
效果:
1public class Hello {2 public static void main(String[] args) {3 System.out.println("Hello, Blog!");4 }5}5. 表格
写法:
1| 姓名 | 语言 | 方向 |2| --- | --- | --- |3| Tangq | Java | 后端 |效果:
| 姓名 | 语言 | 方向 |
|---|---|---|
| Tangq | Java | 后端 |
二、扩展语法(本主题专属)
1. GitHub 仓库卡片
写法:
1::github{repo="Tangq-git/Twilight"}效果:
Tangq-git
/
Twilight
Waiting for api.github.com...
00K
0K
0K
Waiting...2. 提示框(Admonitions)
通用写法::::类型 开始,::: 结束,中间写内容。一共五种类型,效果如下:
Notenote:普通备注,用来补充说明。
Tiptip:小技巧。比如:写作时把
pnpm dev开着,保存即可实时预览。
Importantimportant:重要信息,希望读者一定看到的内容。
Warningwarning:警告。比如:影评写到这里可能涉及轻微剧透。
Cautioncaution:危险操作提醒,比如「执行前请先备份」。
3. 隐藏文本(Spoiler)
写法:
1:spoiler[被隐藏的文字]效果:这句话里藏了一个
适合放剧透、谜底、答案。
三、Frontmatter:文章的「身份证」
每篇文章文件开头的 --- 之间是元信息,本篇文章的是:
1---2title: 写作语法速查:Markdown 与扩展语法实战3published: 2026-11-014description: 列表页显示的摘要5category: 博客使用教程合集6tags: [博客教程, Markdown]7---常用字段速查:
| 字段 | 作用 | 必填 |
|---|---|---|
title | 文章标题 | 是 |
published | 发布日期,决定排序 | 是 |
description | 列表页摘要 | 否 |
cover | 封面图路径 | 否 |
category | 分类(侧栏 Categories) | 否 |
tags | 标签,可多个 | 否 |
draft | 设为 true 就是草稿,不会发布 | 否 |
pinned | 设为 true 在列表置顶 | 否 |
四、小技巧
Tip文章放进
posts/下的子文件夹,侧栏「Directory」会自动按文件夹分组。本篇文章就在「博客使用教程合集」文件夹里。
写完保存 → 本地 pnpm dev 实时预览 → 满意后 commit + push,Vercel 会自动部署上线。
写作语法速查:Markdown 与扩展语法实战
/posts/博客使用教程合集/01-写作语法速查/ Some information may be outdated