mirror of
https://github.com/hanzo-docs/docs.git
synced 2026-10-26 10:55:57 +00:00
e663dedc87fefa5699d859d87f2d4a84e1a31409
Merges upstream commits 1ad82416..20cf96d42 from fuma-nama/fumadocs dev branch, including: - Core/UI/Base-UI version bump 16.5.3 -> 16.6.5 - OpenAPI version bump 10.3.4 -> 10.3.9 (3.2 support, server selector) - TypeScript version bump 5.1.3 -> 5.1.4 (tag parser, type table ID) - Markdown search improvements (inline elements, codeblocks, Vietnamese) - CSS performance improvements and accessibility fixes - MDX stringification using mdast-util-to-markdown - Sidebar active link items support - Mixedbread search moved to server-side - Tailwind CSS plugin forwarding for module resolution - Cursor integration replacing T3 Chat in templates - Template cleanup (removed deprecated mdx-remote example) All fumadocs-* packages renamed to @hanzo/docs-* namespace. Removed duplicate +next+fuma-docs-mdx templates (using hanzo-docs-mdx). Upstream metadata (homepage, repository) updated to Hanzo.
…
Hanzo Docs
The documentation framework for Hanzo AI, Lux Network, Zoo Labs Foundation, and Zen LM.
A powerful React.js documentation framework built for the Hanzo ecosystem.
Features
- Multi-Brand Support: Unified framework supporting Hanzo, Lux, Zoo, and Zen documentation
- Next.js 15+: Built on the latest Next.js with App Router
- MDX: Write documentation in MDX with full component support
- Search: Built-in search with Orama and Algolia support
- TypeScript: Full TypeScript support with auto-generated API docs
- OpenAPI: Generate interactive API documentation from OpenAPI specs
- i18n: Internationalization support for multiple languages
- Themes: Customizable themes with dark mode support
Quick Start
# Install dependencies
pnpm install
# Start development server
pnpm dev
# Build for production
pnpm build
Project Structure
.
├── apps/
│ ├── docs/ # Main documentation site
│ ├── dev-docs/ # Hanzo Dev CLI docs
│ ├── zen-docs/ # Zen LM model docs (zenlm.org)
│ ├── zap-docs/ # ZAP protocol docs
│ └── bot-docs/ # Bot documentation
├── packages/
│ ├── brand/ # Brand configuration (Hanzo, Lux, Zoo)
│ ├── core/ # Core functionality
│ ├── ui/ # UI components
│ ├── mdx/ # MDX processing
│ ├── openapi/ # OpenAPI integration
│ └── ... # Other packages
└── examples/ # Example implementations
Brand Configuration
Set the brand via environment variable:
# .env.local
NEXT_PUBLIC_BRAND=hanzo # or 'lux', 'zoo', or 'zen'
Available Brands
| Brand | Organization | Documentation |
|---|---|---|
hanzo |
Hanzo AI Inc | hanzoai.github.io/docs |
lux |
Lux Network | docs.lux.network |
zoo |
Zoo Labs Foundation | docs.zoo.ngo |
zen |
Zen LM | zenlm.org |
Development
Prerequisites
- Node.js 18.17+
- pnpm 10+
Commands
# Development
pnpm dev # Start all apps in dev mode
pnpm dev:all # Start docs app only
pnpm dev:examples # Start example apps
# Build
pnpm build # Build all packages
pnpm clean # Clean build artifacts
# Quality
pnpm lint # Run ESLint
pnpm lint:prettier # Check formatting
pnpm prettier # Fix formatting
pnpm test # Run tests
pnpm types:check # Type check
Documentation Sites
Hanzo Docs (hanzoai.github.io/docs)
Documentation for Hanzo AI infrastructure including:
- LLM Gateway
- Agent SDK
- MCP Tools
- Chat Platform
- Python/JS SDKs
Lux Docs (docs.lux.network)
Documentation for Lux Network including:
- Architecture & Consensus
- Node Operation
- SDK & CLI
- Smart Contracts
- Post-Quantum Security
Zoo Docs (docs.zoo.ngo)
Documentation for Zoo Labs Foundation including:
- DSO Protocol
- Proof of AI (PoAI)
- Zen Model Family
- Gym SDK
- Training Infrastructure
Forking for New Brands
- Clone this repository
- Create brand config in
packages/brand/src/brands/ - Add CSS in
packages/brand/css/ - Update the brands registry
- Set
NEXT_PUBLIC_BRANDenvironment variable
Contributing
Please read the Contributing Guide before submitting a pull request.
License
MIT © Hanzo AI Inc
Built with Hanzo Docs
Languages
TypeScript
41.7%
MDX
34.6%
JavaScript
20.5%
CSS
1.3%
XSLT
0.7%
Other
1%