快速开始

本指南将帮助你快速上手 AR Docs，创建你的第一个文档页面。

环境要求

Node.js 18+
npm 或 pnpm

创建项目

方式一：使用模板

# 克隆项目
git clone https://github.com/your-repo/ardocs.git
cd ardocs

# 安装依赖
npm install

# 启动开发服务器
npm run dev

方式二：手动创建

# 创建新目录
mkdir my-docs && cd my-docs

# 初始化项目
npm init -y

# 安装依赖
npm install astro @astrojs/cloudflare

项目结构

my-docs/
├── docs/              # 文档目录
│   └── index.mdx      # 首页文档
├── src/
│   ├── pages/         # 页面路由
│   └── components/    # 组件
├── astro.config.mjs   # 配置文件
└── package.json

编写文档

在 docs/ 目录下创建 .mdx 文件：

---
title: '我的第一篇文档'
description: '这是我的第一篇文档'
---

# 欢迎

这是我的第一篇 AR Docs 文档。

常用命令

命令	说明
`npm run dev`	启动开发服务器
`npm run build`	构建生产版本
`npm run preview`	预览构建结果

提示
开发模式下修改文件会自动热重载，无需手动刷新页面。

注意
Cloudflare Pages 部署时需要在项目设置中指定构建命令为 npm run build，输出目录为 dist。