VitePress Generator

Quickly generate static websites using VitePress. Supports installing dependencies, initializing projects, local preview, building, and deployment.

Security Scan

The skill is internally consistent with its stated purpose (scaffolding VitePress sites); it runs local npm/node commands and creates files but does not request credentials or perform unexpected network exfiltration.

Purpose & Capability

Name/description (VitePress site generator) matches the provided files and instructions: SKILL.md describes scaffolding, dev, build, and deployment flows and the repository includes a shell init script and helpful reference docs. All required actions (npm init, npm add -D vitepress, create docs/, add scripts) are appropriate for building a VitePress site.

Instruction Scope

Instructions stay within the scope of creating and building a static site. They run local commands (node, npm) and write project files. Minor inconsistency: SKILL.md says default dev server port 5173 while the init script prints 4173 — this is an innocuous mismatch but worth noting. The instructions do not read environment variables, external config paths, or transmit data to unexpected endpoints.

Install Mechanism

This is an instruction-only skill with a included shell script; there is no install spec that downloads arbitrary archives or introduces third‑party installers. The only network activity implied is normal npm package installation from the package registry when the user runs npm commands.

Credentials

No environment variables, secrets, or external credentials are requested. The commands require Node/npm to be present (documented). No unrelated credentials or config paths are accessed.

Persistence & Privilege

always is false (no forced persistent inclusion) and the skill does not attempt to modify other skills or global agent settings. It will create files in the local filesystem when executed, which is expected for a project initializer.

Assessment

This skill appears to do exactly what it says: scaffold a VitePress site by running local npm/node commands and writing project files. Before running the script, ensure you have Node.js (v18+) and run it in a directory where creating a new project is safe. Note the small inconsistency between SKILL.md (dev server port 5173) and the script's output (4173). Because the script executes npm commands, it will download packages from the npm registry — review package.json and run npm install yourself so you can inspect the installed versions. If you want extra caution, open the provided scripts/init-vitepress-site.sh and the generated package.json to verify nothing unexpected will be added.

VitePress Static Website Generator

Feature Overview

Quickly generate static websites using VitePress. Supports installing dependencies, initializing projects, local preview, building, and deployment.

Trigger Scenarios

• User mentions "static website", "documentation site", "generate website", "build documentation", "create blog", "VitePress", "vitepress", "vuepress", "documentation site", "technical documentation", "project documentation", "personal blog", etc.

Quick Start

When users need to create a static website, follow the process below:

1. Check Environment

First, confirm that the user has Node.js installed:

node -v
npm -v

If not installed, prompt the user to install Node.js first (v18+ recommended).

2. Create Project Directory

mkdir <project-name>
cd <project-name>
npm init -y

3. Install VitePress

npm add -D vitepress

4. Initialize Project Structure

Create the basic directory structure:

<project-name>/
├── docs/
│   ├── .vitepress/
│   │   └── config.mts
│   ├── index.md
│   └── guide/
│       └── getting-started.md
├── package.json
└── README.md

5. Configure Scripts

Add the following to package.json:

{
  "scripts": {
    "docs:dev": "vitepress dev docs",
    "docs:build": "vitepress build docs",
    "docs:preview": "vitepress preview docs"
  }
}

6. Local Preview

npm run docs:dev

Default access: http://localhost:5173

7. Build

npm run docs:build

Output directory: docs/.vitepress/dist/

Complete Configuration Reference

For detailed configuration options, see references/config-guide.md

Theme Customization

For custom themes and styles, see references/theme-customization.md

Deployment Guide

For deployment to different platforms, see references/deployment.md

Quick Command Reference

Command	Description
npm run docs:dev	Start local development server
npm run docs:build	Build production version
npm run docs:preview	Preview build results

Important Notes

1. Node.js Version: Requires v18 or higher
2. Port Usage: Development server uses port 5173 by default
3. Build Output: Build artifacts are located in docs/.vitepress/dist/ directory
4. Config Files: Supports .mts, .ts, .mjs, .js formats