Files
ssw c303c315e5 rocr: rusto-rs 源码入库(上游 v0.2.5 基线 57609fc + 本地补丁)
- 源码 316 文件收编为 rusto-rs/ 文件夹,随本仓库管理
- 移除内部 .git(补丁已存档 docs/rusto-rs-metal-patch-20260912.patch,上游可随时 re-clone)
- target/ 与 docs/.yarn 缓存不入库;本地改动:ROCR_* 环境变量调优 + Metal 链接修复 + 预处理测试脚本
2026-09-12 17:30:04 +08:00
..

RustO! Documentation Site

Documentation site for RustO! — High-Performance, Pure Rust OCR Engine & Multi-Platform Toolkit based on RapidOCR with PaddleOCR engine and MNN inference.

Built with Nuxt, Docus, and Nuxt Content, deployed to GitHub Pages.

🚀 Quick Start

# Install dependencies
yarn install

# Start development server
yarn dev

The documentation site will run at http://localhost:3000.

📁 Project Structure

docs/
├── content/
│   ├── en/                     # English documentation
│   │   ├── index.md            # Landing page
│   │   ├── 01.getting-started/ # Getting started & installation
│   │   ├── 02.how-to/          # How-to guides per platform (Rust, .NET, RN, iOS, Android, C FFI, CLI)
│   │   ├── 03.advance-guide/   # Advanced topics & tuning (Models, Multilingual, Spatial, Preprocessing, Benchmarks)
│   │   └── 04.api-reference/   # API Reference (InitializeConfig, OcrRunOptions, TextResult)
│   └── id/                     # Indonesian documentation
├── components/                 # Vue components (AppHeaderLogo, ProjectBadges)
├── public/                     # Static assets (favicon, images)
├── nuxt.config.ts              # Nuxt configuration
├── app.config.ts               # Docus theme & branding configuration
└── package.json

⚡ Built With

🚀 Deployment

Deploys automatically to GitHub Pages on every push to main that touches the docs/** path via the deploy-docs workflow.

To build manually:

NUXT_APP_BASE_URL=/rusto-rs/ yarn build

Output will be generated in .output/public/.

📄 License

MIT License