Skip to content
cccskills
FreePublished on GitHub

vitepress

Build documentation sites from Markdown with VitePress, then configure navigation, search, and themes. The skill also covers embedding Vue components, organizing multilingual content, and preparing deployment settings for supported hosting platforms.

OriginalShow the original description

VitePress static site generator powered by Vite and Vue. Use when building documentation sites, configuring themes, or writing Markdown with Vue components.

See how to install

Good for

  • Build a documentation site from Markdown
  • Customize navigation, search, and themes
  • Embed Vue components in documentation
  • Configure multilingual pages and deployment

Files included (16)

  • SKILL.md3.6 KB
  • GENERATION.md139 B
  • references/advanced-i18n.md6.3 KB
  • references/advanced-ssr.md4.0 KB
  • references/core-cli.md2.5 KB
  • references/core-config.md7.1 KB
  • references/core-markdown.md6.3 KB
  • references/core-routing.md4.0 KB
  • references/features-code-blocks.md3.6 KB
  • references/features-data-loading.md4.3 KB
  • references/features-dynamic-routes.md4.9 KB
  • references/features-vue.md3.6 KB
  • references/recipes-deploy.md5.3 KB
  • references/theme-config.md6.9 KB
  • references/theme-custom.md5.7 KB
  • references/theme-customization.md8.3 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

VitePress is a Static Site Generator (SSG) built on Vite and Vue 3. It takes Markdown content, applies a theme, and generates static HTML that becomes an SPA for fast navigation. Perfect for documentation, blogs, and marketing sites.

Key Characteristics:

  • File-based routing with .md files
  • Vue components work directly in Markdown
  • Fast HMR with instant updates (<100ms)
  • Default theme optimized for documentation
  • Built-in search (local or Algolia)

Before working with VitePress projects:

  • Check .vitepress/config.ts for site configuration
  • Look at .vitepress/theme/ for custom theme extensions
  • The public/ directory contains static assets served as-is

The skill is based on VitePress 2.0.0-alpha.20, generated at 2026-09-25.

VitePress 2 notes (v1 → v2): install with vitepress@next; requires Node.js 22+. defineConfigWithTheme is deprecated — use defineConfig<ThemeConfig>. Native RTL support (dir option, CSS logical properties) replaces the old PostCSS-plugin approach. Built-in iconify pipeline (icons config, useIcon/VPIcon, collection:name social icons). New assetsBase (CDN) and assetsShards build options; metaChunk removed. Markdown image.lazyLoading renamed to image.lazyLoad.

Core

TopicDescriptionReference
ConfigurationConfig file setup, defineConfig, site metadatacore-config
CLICommand-line interface: dev, build, preview, initcore-cli
RoutingFile-based routing, source directory, rewritescore-routing
MarkdownFrontmatter, containers, tables, anchors, includescore-markdown

Features

Code & Content

TopicDescriptionReference
Code BlocksSyntax highlighting, line highlighting, diffs, focusfeatures-code-blocks
Vue in MarkdownComponents, script setup, directives, templatingfeatures-vue
Data LoadingBuild-time data loaders, createContentLoaderfeatures-data-loading
Dynamic RoutesGenerate pages from data, paths loader filesfeatures-dynamic-routes

Theme

TopicDescriptionReference
Theme ConfigNav, sidebar, search, social links, footertheme-config
CustomizationCSS variables, slots, fonts, global componentstheme-customization
Custom ThemeBuilding themes from scratch, theme interfacetheme-custom

Advanced

TopicDescriptionReference
InternationalizationMulti-language sites, locale configurationadvanced-i18n
SSR CompatibilityServer-side rendering, ClientOnly, dynamic importsadvanced-ssr

Recipes

TopicDescriptionReference
DeploymentGitHub Pages, Netlify, Vercel, Cloudflare, Nginxrecipes-deploy

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

antfu

FreeSummary

Set up JavaScript and TypeScript projects using Anthony Fu’s conventions for code organization, development tools, and package publishing. Establish shared checks for formatting, types, unused code, and tests before committing changes.

  • Setting up a new TypeScript project
  • Standardizing formatting and code checks
  • Managing dependencies across a monorepo
antfu/skills6KUpdated Oct 9, 2026

antfu-create-pr

FreeSummary

Create a GitHub pull request from the current branch with a structured title, a clear explanation of behavior changes, and recorded check results. For UI changes, attach before-and-after screenshots so reviewers can assess the visual differences.

  • Preparing and publishing a PR from the current branch
  • Writing a PR description backed by verification results
  • Attaching before-and-after screenshots for UI changes
antfu/skills6KUpdated Oct 9, 2026

nitro

FreeSummary

Build and configure web servers with Nitro, including request handlers, caching, storage, and scheduled tasks. The skill also guides deployment to supported runtimes and platforms, plus migration from Nitro v2 to v3.

  • Implementing server routes and caching
  • Adding scheduled tasks and WebSocket connections
  • Configuring deployment for supported platforms
antfu/skills6KUpdated Oct 9, 2026

nuxt

FreeSummary

Develop Vue web applications with Nuxt, covering pages, data fetching, shared state, and server API routes. Configure rendering on the server or in the browser, and prepare deployment settings for supported platforms.

  • Build pages and routing for a Vue application
  • Fetch API data and manage shared state
  • Implement server API routes and middleware
antfu/skills6KUpdated Oct 9, 2026

pinia

FreeSummary

Organize shared data and update logic in Vue apps using Pinia stores, containers for application state. The skill guides store definitions, reactive data access, communication between stores, testing, and integration with Nuxt and server-side rendering.

  • Organizing shared data and update logic in Vue apps
  • Connecting stores and extending them with plugins
  • Testing components with mocked stores
antfu/skills6KUpdated Oct 9, 2026

pnpm

FreeSummary

Manage Node.js dependencies with pnpm, from installing packages to coordinating multiple projects in one workspace. The skill covers shared version settings, third-party package patches, dependency overrides, and consistent installation procedures for automated build environments.

  • Unifying dependency versions across a workspace
  • Patching third-party packages and overriding versions
  • Configuring package installation in CI
antfu/skills6KUpdated Oct 9, 2026

See all skills by antfu

Report a problem with this skill