CODEBUDDY.md

This file provides guidance to CodeBuddy Code when working with code in this repository.

Project Overview

This is a VitePress documentation site serving as a mirror of the official ScreenStudio usage guide (ScreenStudio使用指南). It uses VitePress 2.0 (alpha) with Vue 3 and TypeScript configuration.

Commands

npm run docs:dev      # Start dev server with hot reload
npm run docs:build    # Build static site for production
npm run docs:preview  # Preview the production build locally

No lint or test commands are configured.

Architecture

.
├── index.md                  # Home page (hero layout)
├── markdown-examples.md      # VitePress markdown feature demos
├── api-examples.md           # VitePress Runtime API examples
└── .vitepress/
    └── config.mts            # Site configuration (TypeScript)

.vitepress/config.mts is the central configuration file — it controls site title, description, navigation, sidebar, and social links.

All content pages are Markdown files at the root level. New pages must be added to the sidebar/nav config in config.mts to appear in the site.

Key Notes

• VitePress version is ^2.0.0-alpha.17 — a pre-release; some APIs may differ from stable VitePress 1.x docs
• The site title is "ScreenStudio使用指南" and description is "官方使用指南-镜像" (Official Guide Mirror)
• Default VitePress theme is used with no customizations