# Robyn

**Repository Path**: dodoyu/robyn

## Basic Information

- **Project Name**: Robyn
- **Description**: Robyn 是一个具有 Rust 运行时的超快速异步 Python Web 框架。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://robyn.net.cn
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-09-24
- **Last Updated**: 2026-10-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Python, async, Web, robyn, Rust

## README

# Robyn 中文文档

本项目是 [Robyn](https://github.com/sparckles/Robyn) 官方文档的**中文翻译 / 镜像站点**，主要面向国内中文用户。

[Robyn](https://github.com/sparckles/Robyn) 是一个高性能、基于 Rust 的异步 Python Web 框架。

## 与官方文档的关系

- 文档内容同步自官方仓库 [sparckles/Robyn](https://github.com/sparckles/Robyn) 的 `docs_src` 目录。
- 官方文档已内置中文（`zh`）版本；本项目在官方中文基础上，保持了原有的**双栏代码示例**约定：每个示例同时给出 `[untyped]`（去类型注解）与 `[typed]`（带类型注解）两个版本。
- 目前官方仅有英文版的 **会话（sessions）** 页面，本项目已手动翻译为中文，未纳入自动同步。

## 技术栈

基于 [VitePress](https://vitepress.dev/) 构建。

## 本地运行

```bash
# 安装依赖
bun install          # 或 npm install

# 本地预览（默认 http://localhost:5173）
bun run docs:dev     # 或 npm run docs:dev

# 构建静态站点（输出到 docs/.vitepress/dist）
bun run docs:build   # 或 npm run docs:build

# 本地预览构建产物
bun run docs:preview
```

## 目录结构

```
.
├── docs/                      # VitePress 文档源码
│   ├── api-reference/         # API 参考
│   ├── example-application/   # 示例应用
│   ├── .vitepress/
│   │   └── config.mjs         # 站点配置（导航、侧边栏）
│   ├── index.md               # 首页
│   └── ...
├── sync_docs.py               # 官方文档同步脚本
└── package.json
```

## 贡献

欢迎通过 Issue / Pull Request 纠正翻译错误，或同步官方文档的最新更新。