This repository hosts the source code for the UFACTORY Docs website — the centralized documentation hub for UFACTORY robotic arm products.
The documentation covers UFACTORY's product lineup including xArm5, xArm6, xArm7, UFACTORY 850, and Lite6. It provides user manuals, API documentation, support articles, and frequently asked questions (FAQs).
- Bilingual Support — English & Simplified Chinese (zh-Hans)
- Clean & Modern UI — Built with VitePress and styled with Ant Design Vue
- PDF Export — One-click PDF generation for offline reading
- Local Full-Text Search — Fast offline-capable search
- Responsive Design — Optimized for desktop, tablet, and mobile
- Auto-Generated Sidebar — Navigation generated from file structure
This project uses a Git branch strategy to manage documentation for different product lines. Each branch is built and deployed independently:
main # Main branch (currently: user manual)
├── doc_base_framework # Documentation base framework (VitePress theme, config, shared assets)
├── ufactory_doc_850 # UFACTORY 850 product documentation
├── ufactory_doc_accessories # Accessories documentation
├── ufactory_doc_api # API reference (Python SDK, WebSocket, G-code, etc.)
├── ufactory_doc_lite6 # Lite6 product documentation
├── ufactory_doc_releasenote # Release notes
├── ufactory_doc_support_article # Technical support articles
├── ufactory_doc_usermanual # User manual (UFACTORY Studio operation guide)
└── ufactory_doc_xarm # xArm series product documentation
Common directory layout (user manual branch as example):
.vitepress/ # VitePress configuration & custom theme
├── config.mts # Main site config (i18n, nav, sidebar)
├── theme/ # Custom theme (PDF export, style overrides)
└── vitepress-pdf.config_*.ts # PDF export configs
en/ # English documentation
zhHans/ # Simplified Chinese documentation
public/ # Static assets (Netlify redirects, SVG icons)
Contributions are welcome! Please feel free to submit issues or pull requests to help improve the documentation.