# Read.Wiki - Complete Documentation

> Full documentation content for AI tools

Generated: 2026-04-11T17:34:45.216Z

---

## 核心 API

**Language:** 中文
**Path:** /zh/api/core/
**URL:** https://read.wiki/zh/api/core/
**Description:** 核心 API 函数和类
**API Type:** class

## createApp()

创建一个新的应用实例。

### 语法

```typescript
function createApp(options: AppOptions): App
```

### 参数

| 参数 | 类型 | 必需 | 描述 |
|------|------|------|------|
| `options` | `AppOptions` | 是 | 配置选项 |

### AppOptions

```typescript
interface AppOptions {
  name: string;
  version?: string;
  debug?: boolean;
  timeout?: number;
}
```

### 返回值

返回一个 `App` 实例。

### 示例

```javascript
import { createApp } from 'your-package-name';

const app = createApp({
  name: 'My App',
  debug: true,
  timeout: 10000
});
```

## App 类

主应用类。

### 方法

#### run()

启动应用程序。

```typescript
app.run(): Promise<void>
```

#### stop()

停止应用程序。

```typescript
app.stop(): Promise<void>
```

### 属性

| 属性 | 类型 | 描述 |
|------|------|------|
| `name` | `string` | 应用名称 |
| `isRunning` | `boolean` | 应用是否正在运行 |

## 相关链接

- [配置指南](/zh/getting-started/configuration/)
- [基础教程](/zh/tutorials/basics/)

---

## 配置

**Language:** 中文
**Path:** /zh/getting-started/configuration/
**URL:** https://read.wiki/zh/getting-started/configuration/
**Description:** 配置项目的详细说明

## 基础配置

创建配置文件 `config.json`：

```json
{
  "name": "my-project",
  "version": "1.0.0",
  "options": {
    "debug": false,
    "timeout": 5000
  }
}
```

## 配置选项

### 必需选项

- `name` - 项目名称
- `version` - 项目版本

### 可选选项

- `debug` - 是否启用调试模式（默认：`false`）
- `timeout` - 超时时间，单位毫秒（默认：`5000`）

## 环境变量

你也可以通过环境变量进行配置：

```bash
export PROJECT_NAME="my-project"
export DEBUG_MODE="true"
```

## 下一步

配置完成后，继续学习：

- [创建第一个示例](/zh/getting-started/first-example/)
- [了解核心概念](/zh/concepts/)

---

## 第一个示例

**Language:** 中文
**Path:** /zh/getting-started/first-example/
**URL:** https://read.wiki/zh/getting-started/first-example/
**Description:** 创建你的第一个项目示例
**Difficulty:** beginner

## Hello World

让我们创建一个简单的 "Hello World" 示例：

```javascript
import { createApp } from 'your-package-name';

const app = createApp({
  name: 'Hello World',
  debug: true
});

app.run();
```

## 理解代码

1. **导入包** - 我们导入 `createApp` 函数
2. **创建实例** - 传入配置选项
3. **运行应用** - 执行应用程序

## 预期输出

运行此代码后，你应该看到：

```
Hello World application started!
Debug mode: enabled
```

## 常见问题

### 找不到模块

如果看到 "Module not found" 错误，请确保已安装包：

```bash
npm install your-package-name
```

### 权限错误

在 Unix 系统上，你可能需要使用 `sudo`：

```bash
sudo npm install -g your-package-name
```

## 下一步

现在你已经有了一个可运行的示例：

- [探索 API 文档](/zh/api/)
- [学习基础教程](/zh/tutorials/basics/)

---

## 安装

**Language:** 中文
**Path:** /zh/getting-started/installation/
**URL:** https://read.wiki/zh/getting-started/installation/
**Description:** 如何安装和设置项目

## 系统要求

在开始之前，请确保你的系统满足以下要求：

- Node.js 18.0 或更高版本
- npm、yarn 或 pnpm 包管理器
- 操作系统：Windows、macOS 或 Linux

## 安装步骤

### 使用 npm

```bash
npm install your-package-name
```

### 使用 yarn

```bash
yarn add your-package-name
```

### 使用 pnpm

```bash
pnpm add your-package-name
```

## 验证安装

安装完成后，你可以通过以下命令验证安装是否成功：

```bash
npx your-package-name --version
```

如果看到版本号输出，说明安装成功。

## 下一步

- [配置项目](/zh/getting-started/configuration/)
- [创建第一个示例](/zh/getting-started/first-example/)

---

## 进阶教程

**Language:** 中文
**Path:** /zh/tutorials/advanced/
**URL:** https://read.wiki/zh/tutorials/advanced/
**Description:** 掌握高级功能和模式
**Tags:** tutorial, advanced
**Difficulty:** advanced

## 概述

本进阶教程涵盖复杂的使用场景和优化技术。

## 前置要求

开始之前，请确保已完成：
- [基础教程](/zh/tutorials/basics/)
- [核心 API 文档](/zh/api/core/)

## 高级配置

学习如何精细调整你的应用：

```javascript
import { createApp } from 'your-package-name';

const app = createApp({
  name: 'Advanced App',
  version: '2.0.0',
  debug: false,
  timeout: 30000,
  // 高级选项
  retries: 3,
  cache: true,
  parallel: true
});
```

## 性能优化

### 缓存策略

实现缓存以提升性能：

```javascript
const app = createApp({
  name: 'Optimized App',
  cache: {
    enabled: true,
    ttl: 3600,
    maxSize: 100
  }
});
```

### 并行处理

启用并行执行：

```javascript
await app.runParallel([
  task1,
  task2,
  task3
]);
```

## 错误处理

实现健壮的错误处理：

```javascript
try {
  await app.run();
} catch (error) {
  if (error.code === 'TIMEOUT') {
    console.error('操作超时');
  } else if (error.code === 'NETWORK') {
    console.error('网络错误');
  } else {
    console.error('未知错误:', error);
  }
}
```

## 最佳实践

1. **始终使用超时** - 防止操作挂起
2. **启用缓存** - 提升性能
3. **优雅处理错误** - 提供有意义的反馈
4. **使用并行处理** - 最大化吞吐量

## 实际案例

完整的生产就绪示例：

```javascript
import { createApp } from 'your-package-name';

async function productionApp() {
  const app = createApp({
    name: 'Production App',
    version: '1.0.0',
    debug: process.env.NODE_ENV === 'development',
    timeout: 30000,
    retries: 3,
    cache: true
  });

  try {
    await app.run();
    
    // 监控健康状态
    setInterval(async () => {
      const health = await app.checkHealth();
      console.log('健康状态:', health);
    }, 60000);
    
  } catch (error) {
    console.error('致命错误:', error);
    process.exit(1);
  }
}

productionApp();
```

## 下一步

- [最佳实践](/zh/tutorials/best-practices/) - 学习推荐模式
- [API 参考](/zh/api/core/) - 探索所有可用 API

---

## 基础教程

**Language:** 中文
**Path:** /zh/tutorials/basics/
**URL:** https://read.wiki/zh/tutorials/basics/
**Description:** 从零开始学习基础功能
**Tags:** tutorial, basics
**Difficulty:** beginner

## 概述

本教程将带你了解项目的基础功能，适合初学者。

## 学习目标

完成本教程后，你将能够：

- 创建和配置应用实例
- 理解基本的生命周期
- 处理常见的使用场景

## 步骤 1：创建应用

首先，让我们创建一个基本的应用：

```javascript
import { createApp } from 'your-package-name';

const app = createApp({
  name: 'Tutorial App',
  debug: true
});
```

## 步骤 2：配置选项

你可以自定义各种选项：

```javascript
const app = createApp({
  name: 'Tutorial App',
  version: '1.0.0',
  debug: true,
  timeout: 10000
});
```

### 配置说明

- `name` - 应用名称，用于日志和识别
- `version` - 版本号，可选
- `debug` - 启用调试输出
- `timeout` - 操作超时时间（毫秒）

## 步骤 3：运行应用

启动应用非常简单：

```javascript
await app.run();
console.log('应用已启动！');
```

## 步骤 4：停止应用

当需要停止时：

```javascript
await app.stop();
console.log('应用已停止');
```

## 完整示例

将所有步骤组合在一起：

```javascript
import { createApp } from 'your-package-name';

async function main() {
  const app = createApp({
    name: 'Tutorial App',
    debug: true
  });

  try {
    await app.run();
    console.log('应用运行中...');
    
    // 执行一些操作
    await new Promise(resolve => setTimeout(resolve, 5000));
    
    await app.stop();
    console.log('应用已停止');
  } catch (error) {
    console.error('错误:', error);
  }
}

main();
```

## 练习

尝试以下练习来巩固学习：

1. 创建一个应用，设置 30 秒超时
2. 启用调试模式并观察输出
3. 添加错误处理逻辑

## 下一步

- [进阶教程](/zh/tutorials/advanced/) - 学习高级功能
- [API 文档](/zh/api/core/) - 查看完整 API 参考

---

## 最佳实践

**Language:** 中文
**Path:** /zh/tutorials/best-practices/
**URL:** https://read.wiki/zh/tutorials/best-practices/
**Description:** 推荐的模式和实践
**Tags:** tutorial, best-practices
**Difficulty:** intermediate

## 代码组织

### 项目结构

为可维护性组织你的项目：

```
my-project/
├── src/
│   ├── config/
│   ├── utils/
│   └── index.js
├── tests/
└── package.json
```

### 配置管理

将配置分离：

```javascript
// config/app.js
export default {
  name: process.env.APP_NAME || 'My App',
  debug: process.env.DEBUG === 'true',
  timeout: parseInt(process.env.TIMEOUT || '5000')
};

// index.js
import config from './config/app.js';
import { createApp } from 'your-package-name';

const app = createApp(config);
```

## 错误处理

### 优雅降级

始终优雅地处理错误：

```javascript
async function safeRun() {
  try {
    await app.run();
  } catch (error) {
    console.error('错误:', error.message);
    // 降级行为
    await app.runSafeMode();
  }
}
```

### 日志记录

实现适当的日志记录：

```javascript
import { createApp } from 'your-package-name';

const app = createApp({
  name: 'My App',
  logger: {
    level: 'info',
    format: 'json'
  }
});
```

## 测试

### 单元测试

编写全面的测试：

```javascript
import { createApp } from 'your-package-name';
import { describe, it, expect } from 'vitest';

describe('App', () => {
  it('应该创建应用实例', () => {
    const app = createApp({ name: 'Test' });
    expect(app.name).toBe('Test');
  });
});
```

## 安全性

### 输入验证

始终验证用户输入：

```javascript
function validateConfig(config) {
  if (!config.name || typeof config.name !== 'string') {
    throw new Error('无效的名称');
  }
  if (config.timeout && config.timeout < 0) {
    throw new Error('无效的超时时间');
  }
  return config;
}

const app = createApp(validateConfig(userConfig));
```

## 性能

### 资源管理

正确清理资源：

```javascript
async function runWithCleanup() {
  const app = createApp({ name: 'My App' });
  
  try {
    await app.run();
  } finally {
    await app.stop();
    await app.cleanup();
  }
}
```

## 总结

遵循这些最佳实践将帮助你：
- 编写可维护的代码
- 优雅地处理错误
- 确保安全性
- 优化性能

## 相关内容

- [基础教程](/zh/tutorials/basics/)
- [进阶教程](/zh/tutorials/advanced/)

---

## Core API

**Language:** English
**Path:** /en/api/core/
**URL:** https://read.wiki/en/api/core/
**Description:** Core API functions and classes
**API Type:** class

## createApp()

Creates a new application instance.

### Syntax

```typescript
function createApp(options: AppOptions): App
```

### Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `options` | `AppOptions` | Yes | Configuration options |

### AppOptions

```typescript
interface AppOptions {
  name: string;
  version?: string;
  debug?: boolean;
  timeout?: number;
}
```

### Returns

Returns an `App` instance.

### Example

```javascript
import { createApp } from 'your-package-name';

const app = createApp({
  name: 'My App',
  debug: true,
  timeout: 10000
});
```

## App Class

The main application class.

### Methods

#### run()

Starts the application.

```typescript
app.run(): Promise<void>
```

#### stop()

Stops the application.

```typescript
app.stop(): Promise<void>
```

### Properties

| Property | Type | Description |
|----------|------|-------------|
| `name` | `string` | Application name |
| `isRunning` | `boolean` | Whether the app is running |

## See Also

- [Configuration Guide](/en/getting-started/configuration/)
- [Basic Tutorial](/en/tutorials/basics/)

---

## Configuration

**Language:** English
**Path:** /en/getting-started/configuration/
**URL:** https://read.wiki/en/getting-started/configuration/
**Description:** Detailed configuration guide

## Basic Configuration

Create a configuration file `config.json`:

```json
{
  "name": "my-project",
  "version": "1.0.0",
  "options": {
    "debug": false,
    "timeout": 5000
  }
}
```

## Configuration Options

### Required Options

- `name` - Project name
- `version` - Project version

### Optional Options

- `debug` - Enable debug mode (default: `false`)
- `timeout` - Timeout in milliseconds (default: `5000`)

## Environment Variables

You can also configure via environment variables:

```bash
export PROJECT_NAME="my-project"
export DEBUG_MODE="true"
```

## Next Steps

After configuration, continue with:

- [Create your first example](/en/getting-started/first-example/)
- [Learn core concepts](/en/concepts/)

---

## First Example

**Language:** English
**Path:** /en/getting-started/first-example/
**URL:** https://read.wiki/en/getting-started/first-example/
**Description:** Create your first project example
**Difficulty:** beginner

## Hello World

Let's create a simple "Hello World" example:

```javascript
import { createApp } from 'your-package-name';

const app = createApp({
  name: 'Hello World',
  debug: true
});

app.run();
```

## Understanding the Code

1. **Import the package** - We import the `createApp` function
2. **Create an instance** - Pass configuration options
3. **Run the app** - Execute the application

## Expected Output

When you run this code, you should see:

```
Hello World application started!
Debug mode: enabled
```

## Common Issues

### Module not found

If you see "Module not found", ensure you've installed the package:

```bash
npm install your-package-name
```

### Permission errors

On Unix systems, you may need to use `sudo`:

```bash
sudo npm install -g your-package-name
```

## Next Steps

Now that you have a working example:

- [Explore API documentation](/en/api/)
- [Learn basic tutorials](/en/tutorials/basics/)

---

## Installation

**Language:** English
**Path:** /en/getting-started/installation/
**URL:** https://read.wiki/en/getting-started/installation/
**Description:** How to install and set up the project

## System Requirements

Before you begin, ensure your system meets the following requirements:

- Node.js 18.0 or higher
- npm, yarn, or pnpm package manager
- Operating System: Windows, macOS, or Linux

## Installation Steps

### Using npm

```bash
npm install your-package-name
```

### Using yarn

```bash
yarn add your-package-name
```

### Using pnpm

```bash
pnpm add your-package-name
```

## Verify Installation

After installation, verify it was successful by running:

```bash
npx your-package-name --version
```

If you see the version number, the installation was successful.

## Next Steps

- [Configure your project](/en/getting-started/configuration/)
- [Create your first example](/en/getting-started/first-example/)

---

## Advanced Tutorial

**Language:** English
**Path:** /en/tutorials/advanced/
**URL:** https://read.wiki/en/tutorials/advanced/
**Description:** Master advanced features and patterns
**Tags:** tutorial, advanced
**Difficulty:** advanced

## Overview

This advanced tutorial covers complex use cases and optimization techniques.

## Prerequisites

Before starting, ensure you've completed:
- [Basics Tutorial](/en/tutorials/basics/)
- [Core API Documentation](/en/api/core/)

## Advanced Configuration

Learn how to fine-tune your application:

```javascript
import { createApp } from 'your-package-name';

const app = createApp({
  name: 'Advanced App',
  version: '2.0.0',
  debug: false,
  timeout: 30000,
  // Advanced options
  retries: 3,
  cache: true,
  parallel: true
});
```

## Performance Optimization

### Caching Strategy

Implement caching for better performance:

```javascript
const app = createApp({
  name: 'Optimized App',
  cache: {
    enabled: true,
    ttl: 3600,
    maxSize: 100
  }
});
```

### Parallel Processing

Enable parallel execution:

```javascript
await app.runParallel([
  task1,
  task2,
  task3
]);
```

## Error Handling

Implement robust error handling:

```javascript
try {
  await app.run();
} catch (error) {
  if (error.code === 'TIMEOUT') {
    console.error('Operation timed out');
  } else if (error.code === 'NETWORK') {
    console.error('Network error');
  } else {
    console.error('Unknown error:', error);
  }
}
```

## Best Practices

1. **Always use timeouts** - Prevent hanging operations
2. **Enable caching** - Improve performance
3. **Handle errors gracefully** - Provide meaningful feedback
4. **Use parallel processing** - Maximize throughput

## Real-World Example

Complete production-ready example:

```javascript
import { createApp } from 'your-package-name';

async function productionApp() {
  const app = createApp({
    name: 'Production App',
    version: '1.0.0',
    debug: process.env.NODE_ENV === 'development',
    timeout: 30000,
    retries: 3,
    cache: true
  });

  try {
    await app.run();
    
    // Monitor health
    setInterval(async () => {
      const health = await app.checkHealth();
      console.log('Health:', health);
    }, 60000);
    
  } catch (error) {
    console.error('Fatal error:', error);
    process.exit(1);
  }
}

productionApp();
```

## Next Steps

- [Best Practices](/en/tutorials/best-practices/) - Learn recommended patterns
- [API Reference](/en/api/core/) - Explore all available APIs

---

## Basics Tutorial

**Language:** English
**Path:** /en/tutorials/basics/
**URL:** https://read.wiki/en/tutorials/basics/
**Description:** Learn the fundamentals from scratch
**Tags:** tutorial, basics
**Difficulty:** beginner

## Overview

This tutorial will guide you through the basic features, perfect for beginners.

## Learning Objectives

After completing this tutorial, you will be able to:

- Create and configure application instances
- Understand the basic lifecycle
- Handle common use cases

## Step 1: Create an Application

First, let's create a basic application:

```javascript
import { createApp } from 'your-package-name';

const app = createApp({
  name: 'Tutorial App',
  debug: true
});
```

## Step 2: Configure Options

You can customize various options:

```javascript
const app = createApp({
  name: 'Tutorial App',
  version: '1.0.0',
  debug: true,
  timeout: 10000
});
```

### Configuration Explained

- `name` - Application name for logging and identification
- `version` - Version number, optional
- `debug` - Enable debug output
- `timeout` - Operation timeout in milliseconds

## Step 3: Run the Application

Starting the application is simple:

```javascript
await app.run();
console.log('Application started!');
```

## Step 4: Stop the Application

When you need to stop:

```javascript
await app.stop();
console.log('Application stopped');
```

## Complete Example

Putting it all together:

```javascript
import { createApp } from 'your-package-name';

async function main() {
  const app = createApp({
    name: 'Tutorial App',
    debug: true
  });

  try {
    await app.run();
    console.log('Application running...');
    
    // Do some work
    await new Promise(resolve => setTimeout(resolve, 5000));
    
    await app.stop();
    console.log('Application stopped');
  } catch (error) {
    console.error('Error:', error);
  }
}

main();
```

## Exercises

Try these exercises to reinforce your learning:

1. Create an app with a 30-second timeout
2. Enable debug mode and observe the output
3. Add error handling logic

## Next Steps

- [Advanced Tutorial](/en/tutorials/advanced/) - Learn advanced features
- [API Documentation](/en/api/core/) - View complete API reference

---

## Best Practices

**Language:** English
**Path:** /en/tutorials/best-practices/
**URL:** https://read.wiki/en/tutorials/best-practices/
**Description:** Recommended patterns and practices
**Tags:** tutorial, best-practices
**Difficulty:** intermediate

## Code Organization

### Project Structure

Organize your project for maintainability:

```
my-project/
├── src/
│   ├── config/
│   ├── utils/
│   └── index.js
├── tests/
└── package.json
```

### Configuration Management

Keep configuration separate:

```javascript
// config/app.js
export default {
  name: process.env.APP_NAME || 'My App',
  debug: process.env.DEBUG === 'true',
  timeout: parseInt(process.env.TIMEOUT || '5000')
};

// index.js
import config from './config/app.js';
import { createApp } from 'your-package-name';

const app = createApp(config);
```

## Error Handling

### Graceful Degradation

Always handle errors gracefully:

```javascript
async function safeRun() {
  try {
    await app.run();
  } catch (error) {
    console.error('Error:', error.message);
    // Fallback behavior
    await app.runSafeMode();
  }
}
```

### Logging

Implement proper logging:

```javascript
import { createApp } from 'your-package-name';

const app = createApp({
  name: 'My App',
  logger: {
    level: 'info',
    format: 'json'
  }
});
```

## Testing

### Unit Tests

Write comprehensive tests:

```javascript
import { createApp } from 'your-package-name';
import { describe, it, expect } from 'vitest';

describe('App', () => {
  it('should create app instance', () => {
    const app = createApp({ name: 'Test' });
    expect(app.name).toBe('Test');
  });
});
```

## Security

### Input Validation

Always validate user input:

```javascript
function validateConfig(config) {
  if (!config.name || typeof config.name !== 'string') {
    throw new Error('Invalid name');
  }
  if (config.timeout && config.timeout < 0) {
    throw new Error('Invalid timeout');
  }
  return config;
}

const app = createApp(validateConfig(userConfig));
```

## Performance

### Resource Management

Clean up resources properly:

```javascript
async function runWithCleanup() {
  const app = createApp({ name: 'My App' });
  
  try {
    await app.run();
  } finally {
    await app.stop();
    await app.cleanup();
  }
}
```

## Summary

Following these best practices will help you:
- Write maintainable code
- Handle errors gracefully
- Ensure security
- Optimize performance

## Related

- [Basics Tutorial](/en/tutorials/basics/)
- [Advanced Tutorial](/en/tutorials/advanced/)

---

## Welcome to Read.Wiki

**Language:** Other
**Path:** /en/
**URL:** https://read.wiki/en/
**Description:** Start building your documentation site with Read.Wiki

import { Card, CardGrid } from '@astrojs/starlight/components';

## Features

<CardGrid stagger>
	<Card title="Quick Start" icon="rocket">
		Get up and running in minutes with our simple setup guide.
	</Card>
	<Card title="Complete API Documentation" icon="open-book">
		Detailed API reference with all functions, classes, and methods.
	</Card>
	<Card title="Rich Tutorials" icon="pencil">
		From basics to advanced topics, learn everything you need.
	</Card>
	<Card title="AI-Friendly" icon="star">
		Supports MCP protocol for seamless AI tool integration.
	</Card>
</CardGrid>

## Start Exploring

Choose a topic to begin your journey:

- **[Getting Started](/en/getting-started/installation/)** - Installation and configuration
- **[Core Concepts](/en/concepts/)** - Understand the fundamentals
- **[API Reference](/en/api/)** - Complete API documentation
- **[Tutorials](/en/tutorials/basics/)** - Practical guides and best practices

---

## Example Guide

**Language:** Other
**Path:** /guides/example/
**URL:** https://read.wiki/guides/example/
**Description:** A guide in my new Starlight docs site.

Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
Writing a good guide requires thinking about what your users are trying to do.

## Further reading

- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework

---

## Welcome to Starlight

**Language:** Other
**Path:** /index/
**URL:** https://read.wiki/index/
**Description:** Get started building your docs site with Starlight.

import { Card, CardGrid } from '@astrojs/starlight/components';

## Next steps

<CardGrid stagger>
	<Card title="Update content" icon="pencil">
		Edit `src/content/docs/index.mdx` to see this page change.
	</Card>
	<Card title="Change page layout" icon="document">
		Delete `template: splash` in `src/content/docs/index.mdx` to display a
		sidebar on this page.
	</Card>
	<Card title="Add new content" icon="add-document">
		Add Markdown or MDX files to `src/content/docs` to create new pages.
	</Card>
	<Card title="Configure your site" icon="setting">
		Edit your `sidebar` and other config in `astro.config.mjs`.
	</Card>
	<Card title="Read the docs" icon="open-book">
		Learn more in [the Starlight Docs](https://starlight.astro.build/).
	</Card>
</CardGrid>

---

## Example Reference

**Language:** Other
**Path:** /reference/example/
**URL:** https://read.wiki/reference/example/
**Description:** A reference page in my new Starlight docs site.

Reference pages are ideal for outlining how things work in terse and clear terms.
Less concerned with telling a story or addressing a specific use case, they should give a comprehensive outline of what you're documenting.

## Further reading

- Read [about reference](https://diataxis.fr/reference/) in the Diátaxis framework

---

## 欢迎来到 Read.Wiki

**Language:** Other
**Path:** /zh/
**URL:** https://read.wiki/zh/
**Description:** 开始使用 Read.Wiki 构建你的文档站点

import { Card, CardGrid } from '@astrojs/starlight/components';

## 特性

<CardGrid stagger>
	<Card title="快速开始" icon="rocket">
		通过简单的步骤快速上手，几分钟内即可开始使用。
	</Card>
	<Card title="完整的 API 文档" icon="open-book">
		详细的 API 参考文档，包含所有函数、类和方法的说明。
	</Card>
	<Card title="丰富的教程" icon="pencil">
		从基础到进阶的完整教程，帮助你掌握所有功能。
	</Card>
	<Card title="AI 友好" icon="star">
		支持 MCP 协议，可被现代 AI 工具直接读取和理解。
	</Card>
</CardGrid>

## 开始探索

选择一个主题开始你的学习之旅：

- **[快速开始](/zh/getting-started/installation/)** - 安装和配置指南
- **[核心概念](/zh/concepts/)** - 理解基本概念和架构
- **[API 文档](/zh/api/)** - 完整的 API 参考
- **[教程](/zh/tutorials/basics/)** - 实践教程和最佳实践

---