---
title: "示例文档：Markdown 写作速览"
description: "一份用纯 Markdown 写成的示例文档，演示 Nimbus 里最常用的写作元素。"
---

> Documentation Index
> Fetch the complete documentation index at: https://example.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 示例文档：Markdown 写作速览

这是一份示例文档，全部用纯 Markdown 写成——在 IDE 或任何文本编辑器里打开即写，不需要学新语法。

## 标题与段落

用 `#` 到 `######` 写六级标题。段落之间空一行，**加粗**、*斜体*、`行内代码` 都和标准 Markdown 一样。

## 列表

无序列表：

- 第一项
- 第二项
  - 嵌套项

有序列表：

1. 先搭脚手架
2. 再写文档
3. 最后构建发布

## 代码块

```bash
npx @cloudflare/create-nimbus-docs@latest my-docs
cd my-docs
npm install
npm run dev
```

## 表格

| 命令          | 作用             |
| ------------- | ---------------- |
| `npm run dev` | 本地预览，热重载 |
| `npm run build` | 构建静态站点   |
| `npm run lint:docs` | 检查文档写法 |

## 链接与引用

- 官方文档：[nimbus-docs.com](https://nimbus-docs.com)
- 开源仓库：[cloudflare/nimbus](https://github.com/cloudflare/nimbus)

> 提示：Nimbus 会在构建时校验每页的 frontmatter，写错了会给出人类能看懂的报错，而不是静默失败。

## 小结

日常写作就是：打开 `.md` 文件 → 写 Markdown → `npm run dev` 预览 → `npm run build` 发布。和写笔记的流程几乎一样。

Source: https://example.com/sample-guide/index.mdx