基础语法 / 标题

标题

标题的核心作用是搭出文档骨架。写 README、上手指南或发布说明时,先决定内容层级,再决定用哪一级标题。

语法说明

在 Markdown 中,标题通过在行首添加 # 创建。井号越多,层级越深。把它想成文档目录,而不是字号开关。

# 项目概览
## 快速开始
### 环境要求
### 本地运行
## 部署说明
### GitHub Pages
#### 常见问题
##### 缓存刷新
###### 临时解决方案

效果预览

项目概览

快速开始

环境要求

本地运行

缓存刷新
临时解决方案

写作建议

  • 每个页面通常只保留一个一级标题,用来说明这页到底在讲什么。
  • 不要为了“视觉变化”跳级,目录、侧边栏和可访问性都依赖稳定层级。
  • 标题最好写成可扫描的信息,比如“部署说明”“常见问题”,少用“更多内容”这种空词。
  • 如果一段内容无法放进现有层级,优先重想结构,而不是继续加粗正文。

替代语法

一级和二级标题也可以使用底划线写法。它偶尔会出现在旧 README 或临时笔记里,但长期维护时还是 # 更稳定、也更好扫读。

发布说明


已知问题


发布说明
===

已知问题
---

如果你在维护一组长期更新的文档,优先使用井号标题。它更直观,也更方便后续生成目录和锚点链接。

评论

评论区暂未开放。

需要先为这个仓库启用 GitHub Discussions,并完成 giscus 配置后,评论功能才可用。