Skip to content

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

Documentation website for IINA.ai (an LLM API service provider) built with VitePress (Vue 3 + Vite). All content is written in Simplified Chinese.

Commands

bash
pnpm docs:dev      # Start dev server with hot reload
pnpm docs:build    # Build for production
pnpm docs:preview  # Preview production build locally

Package manager: pnpm (v8+), Node.js 20+.

Architecture

  • .vitepress/config.mjs — Main VitePress config: navigation, sidebar, markdown plugins (footnotes, tabs, group-icons)
  • .vitepress/theme/index.ts — Custom theme extending VitePress default; integrates medium-zoom for images and tabs plugin
  • .vitepress/theme/style.css — Custom CSS overrides
  • Content is organized as Markdown files at the root and in topic directories (cli/, chat/, agents/)
  • public/icons/ — Static SVG icons for file type indicators

Content Structure

DirectoryPurpose
index.mdHomepage with feature highlights and pricing tables
quickstart.mdAPI integration examples (Python/TypeScript)
faq.mdFrequently asked questions
model-changelog.mdModel version history (frequently updated)
cli/CLI tool integration guides (Claude Code, CodeX, Gemini CLI)
chat/Chat client setup guides (Alma, Cherry Studio, ChatWise)
agents/Agent tool documentation (OpenClaw)

Deployment

Automated via GitHub Actions on push to main:

  1. Builds with pnpm run docs:build
  2. Uploads to Alibaba OSS (oss-cn-hongkong)
  3. Refreshes Alibaba CDN

Conventions

  • Markdown uses VitePress syntax: ::: containers for callouts (details, warning, tip), code groups with tabs for multi-language examples
  • Model updates go in model-changelog.md with date and description
  • Two API endpoints referenced throughout: iina.ai (overseas) and acc.iina.ai (mainland China optimized)