中文 | English

LILYGO Documentation

LILYGO product documentation site, built with VitePress, with bilingual (English / Chinese) support.

Requirements

• Node.js 18+
• npm

Install Dependencies

npm install

Development Mode

npm run dev

Once started, visit http://localhost:5173 (or the address shown in the terminal). The --host flag is built in, so other devices on the LAN can access it too.

Changes to .md files or configs/components under .vitepress/ hot-reload automatically.

Production Build

npm run build

Output is written to vitepress-dist/ .

Preview Production Build

npm run preview

Serves the static files generated by build locally, for pre-deployment verification.

Content Structure

en/          # English docs
  products/  # product pages, one index.md per product
  open-source/
  dev-tools/
zh/          # Chinese docs (mirrors en/ structure)
public/      # static assets (images, logo, firmware .bin files)
.vitepress/
  config.mts          # root config
  config/en.ts        # English sidebar (auto-generated by scanning the filesystem)
  config/zh.ts        # Chinese sidebar
  products.data.ts    # product catalog data loader
  theme/              # custom theme and Vue components

Contributing

For detailed documentation standards, product naming reference, and product page structure, see CONTRIBUTING.md.