---
title: "快速开始"
description: "在自己的电脑上运行一个 Nimbus 文档站。"
---

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

# 快速开始

本指南使用 [Bun](https://bun.sh) 作为包管理器。脚手架也支持 npm、pnpm 与 Yarn，命令只需做相应替换。

## 准备工作

需要 Node.js 22.12.0 或更高版本，以及已安装的 Bun。

```sh
node --version
bun --version
```

> **为什么仍然需要 Node**
>
> Nimbus 的脚手架与部分构建工具依赖 Node 运行时。Bun 负责安装依赖和运行脚本，Node 版本需要满足最低要求。

## 创建站点

运行脚手架，把一个新的文档站写进当前目录下的 `my-docs/`：

```sh
bun create @cloudflare/nimbus-docs@latest my-docs --yes
```

`--yes` 会跳过交互式问题，采用示例页面、Cloudflare 静态部署配置，并初始化 git 仓库、安装依赖。

> **更精简的起点**
>
> 如果不需要示例页面，加上 `--content empty`；如果站点从根路径提供 API 参考，可以使用 `--template api`。完整参数见 [create-nimbus-docs](https://github.com/cloudflare/nimbus/tree/main/packages/create-nimbus-docs)。

## 启动开发服务器

```sh
cd my-docs
bun run dev
```

你应该会看到类似下面的输出：

```text
 astro v7.x.x ready in 300 ms ┃ Local http://localhost:4321/ ┃ Network use --host to expose
```

打开 [http://localhost:4321](http://localhost:4321)，首页、侧边栏和示例页面就都在了。

脚手架已经把布局、组件和样式写进 `my-docs/`。它们都是你的源码，可以随意修改。

> **搜索需要先构建**
>
> 搜索读取构建时生成的索引。开发服务器里搜索可能不可用；运行 `bun run build`，再运行 `bun run preview` 后即可搜索。

## 编辑首页

打开 `src/content/docs/index.mdx`，修改 frontmatter 中的 `title`，保存。页面会带着新标题重新加载，这是确认改动生效最快的方式。

## 修改站点信息

站点的名称、地址和描述在 `astro.config.ts` 中配置：

```ts title="astro.config.ts" {3-7}
const nimbusConfig = defineNimbusConfig({
  site: "https://docs.example.com",
  title: "我的文档",
  description: "我的产品指南与参考。",
  locale: "zh-CN",
  homeLabel: "首页",
});
```

`site` 是站点的正式地址，决定 canonical URL、社交卡片、`robots.txt` 和 sitemap。部署前务必换成真实域名。

## 页面放在哪里

页面是 `src/content/docs/` 下的 `.mdx` 或 `.md` 文件，文件路径就是 URL：

| 文件 | URL |
| --- | --- |
| `src/content/docs/index.mdx` | `/` |
| `src/content/docs/quickstart.mdx` | `/quickstart/` |
| `src/content/docs/guides/deploy.mdx` | `/guides/deploy/` |

新建一个带 `title` 的 MDX 文件，保存后它就会自动出现在侧边栏。

## 下一步

- 阅读[项目结构](/project-structure/)，了解脚手架写进仓库的目录与框架边界。
- 阅读[写作与页面](/writing/pages-and-routing/)，掌握 frontmatter、侧边栏排序与 MDX 组件。
- 阅读[配置](/reference/configuration/)，调整侧边栏、搜索、版本与渲染方式。
- 阅读[部署](/deploy/)，把站点发布到 GitHub Pages、Cloudflare 或其他主机。
- 用 `nimbus-docs check` 在发布前检查配置、链接与组件。

Source: https://nimbus.ndjp.net/quickstart/index.mdx