跳至内容
怎么写一篇文档

怎么写一篇文档

一篇页面就是一个 Markdown 文件,开头用 YAML 写元数据。

---
title: 页面标题
weight: 10
---

正文从这里开始。

建议

  • 标题写读者要找的词,不要写「说明」「杂记」。
  • 结构化内容进 docs/,随手记进 blog/
  • 一篇只讲一件事。流程太长就拆页。
  • 能用列表就不要用长段落。

常用块

卡片:

{{< cards >}}
  {{< card link="getting-started" title="开始使用" icon="sparkles" >}}
{{< /cards >}}

提示:

callout 适合注意事项,不要拿来堆正文。

代码块可以带文件名:

hugo.yaml
title: Qin