mirror of
https://github.com/hanzo-docs/docs.git
synced 2026-10-24 20:09:02 +00:00
5756e81984e89900334e2c465a1ca3448cfd5a49
# Conflicts: # apps/docs/app/(home)/sponsors/data.tsx # apps/docs/app/(home)/uwu.tsx # apps/docs/app/og/[...slug]/generate.tsx # apps/docs/app/static.json/route.ts # apps/docs/content/blog/customise-ui.mdx # apps/docs/content/blog/mdx-v10-summary.mdx # apps/docs/content/blog/openapi-v9.mdx # apps/docs/content/blog/v15.mdx # apps/docs/content/blog/v16-2.mdx # apps/docs/content/docs/(framework)/deploying/static.mdx # apps/docs/content/docs/(framework)/integrations/content/custom.mdx # apps/docs/content/docs/(framework)/integrations/openapi/generate-files.mdx # apps/docs/content/docs/(framework)/integrations/openapi/server.mdx # apps/docs/content/docs/(framework)/integrations/story/client.story.tsx # apps/docs/content/docs/(framework)/integrations/story/index.mdx # apps/docs/content/docs/(framework)/integrations/story/next.mdx # apps/docs/content/docs/(framework)/search/orama.mdx # apps/docs/content/docs/(framework)/what-is-fumadocs.mdx # apps/docs/content/docs/cli/index.mdx # apps/docs/content/docs/headless/mdx/headings.mdx # apps/docs/content/docs/headless/mdx/rehype-code.mdx # apps/docs/content/docs/headless/mdx/remark-image.mdx # apps/docs/content/docs/headless/source-api/plugins.mdx # apps/docs/content/docs/mdx/(integrations)/loader/node.mdx # apps/docs/content/docs/mdx/global.mdx # apps/docs/content/docs/mdx/index.mdx # apps/docs/content/docs/ui/components/banner.mdx # apps/docs/content/docs/ui/components/graph-view.mdx # apps/docs/content/docs/ui/layouts/flux.mdx # apps/docs/content/docs/ui/layouts/home-layout.mdx # apps/docs/content/docs/ui/layouts/root-provider.mdx # apps/docs/content/docs/ui/theme.mdx # apps/docs/eslint.config.mjs # apps/docs/scripts/preload.ts # apps/docs/scripts/update-orama-index.ts # examples/openapi/README.md # examples/openapi/scripts/generate-docs.ts # examples/react-router-i18n/scripts/preload.ts # examples/tanstack-start-story/src/components/callout/story-client.tsx # packages/base-ui/scripts/compile-inline.utils.ts # packages/cli/src/build/index.ts # packages/core/src/content/md/frontmatter.ts # packages/create-app/scripts/update-git-repo.js # packages/create-app/scripts/update-git-repo.sh # packages/mdx-runtime/eslint.config.mjs # packages/openapi/scripts/compile-inline.utils.ts # packages/openapi/src/server/create.ts # packages/openapi/src/ui/full.tsx # packages/openapi/src/utils/process-document.ts # packages/press/waku.config.ts # packages/radix-ui/scripts/compile-inline.utils.ts
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.6%
CSS
1.2%
XSLT
0.7%
Other
1%