跳到内容
小木鱼
Go back

Markdown 完整写作示例 — 一篇看懂所有格式

Updated:
编辑页面

Markdown 是写博客最常用的标记语言。这篇文章演示了你 可能用到的全部语法,写文章时直接对照即可。

提示:本文仅展示格式效果,不涉及复杂概念,所见即所得。


一、标题体系

标题从 ####### 共六级:

一级标题(通常文章只有一个,这里仅为演示)

二级标题 — 主要章节

三级标题 — 子章节

四级标题 — 小标题

五级标题
六级标题

二、文本样式

普通正文,加粗斜体加粗斜体删除线行内代码下划线(HTML 标签)。

上标:X^2^,下标:H2O

这条文字已经过时了。

某些 Markdown 引擎支持上标/下标语法,若不生效可用 HTML 替代:<sup><sub>


三、引用

这是一级引用。

这是二级引用(嵌套)。

三级引用,层层递进。

回到一级引用。

引用内也可以包含其他格式:

注意:引用里的 代码 和列表依然有效。

  • 第一项
  • 第二项

四、列表

无序列表

有序列表

  1. 需求分析
  2. 系统设计
    1. 架构设计
    2. 数据库设计
  3. 开发编码
  4. 测试部署

任务列表(勾选框)


五、代码展示

行内代码

安装依赖请执行 npm install 或者 pnpm install

JavaScript 代码块

// 这是一个 JavaScript 示例
function fibonacci(n) {
  if (n <= 1) return n
  return fibonacci(n - 1) + fibonacci(n - 2)
}

const result = fibonacci(10)
console.log(`斐波那契第 10 项: ${result}`)

Python 代码块

# Python 示例
def merge_sort(arr):
    if len(arr) <= 1:
        return arr
    mid = len(arr) // 2
    left = merge_sort(arr[:mid])
    right = merge_sort(arr[mid:])
    return merge(left, right)

def merge(left, right):
    result = []
    i = j = 0
    while i < len(left) and j < len(right):
        if left[i] <= right[j]:
            result.append(left[i])
            i += 1
        else:
            result.append(right[j])
            j += 1
    result.extend(left[i:] or right[j:])
    return result

带有高亮的代码块

// 插入行用 ins,删除行用 del
function greet(name) {
  // 这三行是新增的
  const prefix = "你好"
  const suffix = ""
  return `${prefix}${name}${suffix}`
  // 这三行被替换了
  // 旧版的实现
  // return "Hello, " + name
}

带有文件名的代码块

---
const { label } = Astro.props;
---

<button class="btn">{label}</button>

<style>
  .btn {
    padding: 8px 16px;
    border-radius: 6px;
    background: #3b82f6;
    color: white;
  }
</style>

命令行输出

$ git status
On branch master
Your branch is up to date with 'origin/master'.

untracked files:
  (use "git add <file>..." to include in what will be committed)
	src/data/blog/markdown-full-guide.md

JSON

{
  "site": {
    "title": "小木鱼",
    "url": "https://xiaomuyuiii.top",
    "lang": "zh-CN"
  },
  "posts": [
    { "title": "Markdown 示例", "published": true },
    { "title": "未发布草稿", "published": false }
  ]
}

六、图片

外部图片链接

风景图片

本地图片

AstroPaper v5

注意:本地图片路径相对于 src/data/blog/,所以用 ../assets/images/。你也可以把图片放在 public/ 目录下,直接用 /图片名.png 引用。

带链接的图片

点击跳转 GitHub


七、表格

基本表格

特性支持情况备注
暗色模式跟随系统
全文搜索Pagefind 驱动
RSS 订阅自动生成
评论系统🚧开发中
分类浏览新增功能

对齐方式

左对齐居中对齐右对齐
苹果香蕉橘子
前端全栈后端
100200300

内容较多的表格

框架版本类型优点缺点
React19前端库生态庞大、灵活度高学习曲线较陡
Vue3前端框架上手简单、文档友好生态略小于 React
Astro5静态站点框架零 JS 输出、性能极佳不适合复杂交互页面
Svelte5前端编译框架编译型、打包体积小社区生态较小

八、链接

普通链接

GitHub

小木鱼的博客

带标题的链接

Astro 官网

引用式链接(适合多次引用同一链接)

AstroPaper 是一个基于 Astro 的博客主题。如果你喜欢这个主题,可以去 AstroPaper 的 GitHub 仓库点个 Star。

页内锚点

跳到文末署名


九、分割线

分隔内容时使用分割线:




三条分割线上面有一条、中间有两条,下面没有。区分段落很实用。


十、脚注

Markdown 支持脚注语法,用于在页面底部添加注释说明。

这是一段需要说明的文字1,这里还有另一个注释2


十一、定义列表

Markdown : 一种轻量级标记语言,由 John Gruber 创建。

Astro : 一个现代化的静态站点生成框架,支持多框架组件。

SSG : Static Site Generator,静态站点生成器,预渲染页面为 HTML。


十二、HTML 扩展

点击展开查看详情

这里是被折叠的内容。适合放长文说明、代码片段或 FAQ 答案。

  • 支持列表
  • 加粗文字
  • 行内代码
print("折叠块里的代码也可以高亮")

彩色文字(某些主题支持):

红色 蓝色 绿色


十三、告警块(GFM 扩展)

注意:这是一条普通提示。

警告:这是一条警告信息,请仔细阅读。

危险:这是一个危险操作提示!

提示:这是一个有用的提示。


十四、数学公式(需插件支持)

如果博客配置了 KaTeX 或 MathJax,可以写公式:

行内公式:$E = mc^2$

块级公式:

$$ \int_{a}^{b} f(x) , dx = F(b) - F(a) $$

$$ \frac{-b \pm \sqrt{b^2 - 4ac}}{2a} $$


十五、Emoji

:smile: :heart: :rocket: :fire: :100: :+1:

:warning: :book: :computer: :memo: :star:

注意:Emoji 简码(:smile: 等)需要 Markdown 引擎支持。大多数平台直接用 Emoji 原文 😄 🚀 🔥 更稳妥。


十六、嵌入内容

YouTube 视频


总结

以上就是 Markdown 的完整语法使用示例。主要覆盖了:

类别语法用途
标题# ~ ######内容层级结构
文本样式** * ~~ `文字修饰
列表- 1. - [x]组织条目
代码``` + 语言名称展示代码片段
图片![alt](url)插入图片
链接[text](url)引用外部资源
表格| 列1 | 列2 |数据对比
引用>引用他人观点
分割线---分隔内容段落
脚注[^1]添加注释说明
HTML直接写 HTML 标签扩展格式

把这些语法记住,写博客基本就没有格式障碍了。需要什么功能直接来这篇文章里复制粘贴就行。


📝 作者署名与许可协议

作者:小木鱼 · GitHub · 博客

许可协议CC BY-NC-SA 4.0

您可以自由分享和改编,但需注明出处、不得用于商业用途、相同方式共享。


最后更新:2026 年 5 月 4 日

Footnotes

  1. 这是第一条脚注的内容,通常用来解释某个术语或提供参考来源。

  2. 第二条脚注,可以放补充说明。脚注会自动跳转到文末。


编辑页面

Was this helpful? React below:


下一篇
Markdown 写作示例