vitepress-skilld
Skill184 starsChanged 37 days agoMITView on GitHub
Use when writing, configuring, or debugging code that imports "vitepress", when running vitepress CLI commands, editing .vitepress/config or theme files, tuning markdown or default theme options, or migrating a VitePress site. Provides the vitepress@1.6.4 API surface, config reference, theme reference, CLI usage, and v1 migration notes.
In this repository35 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- floating-ui-vue-skilldSkill
- formkit-core-skilldSkill
- motion-v-skilldSkill
- pinia-colada-skilldSkill
- pinia-skilldSkill
- primevue-skilldSkill
- quasar-skilldSkill
- reka-ui-skilldSkill
- shadcn-vue-skilldSkill
- slidev-cli-skilldSkill
- tanstack-ai-vue-skilldSkill
- tanstack-vue-form-skilldSkill
- tanstack-vue-query-skilldSkill
- tanstack-vue-router-skilldSkill
- tanstack-vue-store-skilldSkill
- tanstack-vue-table-skilldSkill
- tanstack-vue-virtual-skilldSkill
- tresjs-core-skilldSkill
- unhead-vue-skilldSkill
- unovis-ts-skilldSkill
- unovis-vue-skilldSkill
- vee-validate-skilldSkill
- vue-data-ui-skilldSkill
- vue-i18n-skilldSkill
- vue-router-skilldSkill
- vue-skilldSkill
- vue-test-utils-skilldSkill
- vuetify-skilldSkill
- vueuse-components-skilldSkill
- vueuse-core-skilldSkill
- vueuse-integrations-skilldSkill
- vueuse-math-skilldSkill
- vueuse-motion-skilldSkill
- vueuse-shared-skilldSkill
The file
We split this skill into the rules it gives an agent
4 rules. About 0 are common, 0 are distinctive, and 4 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
4
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 91
Import as import { data } from './posts.data.js'.
- Very specific: line 108
Use createContentLoader for archive and index pages instead of hand-rolled loaders.
- Very specific: line 113
Keep image and asset URLs relative in Markdown so Vite hashes and inlines them.
- Very specific: line 159
When markdown.headers is enabled, extraction levels default to [2, 3] (dist/node/index.d.ts:1769-1786).
≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
vitepress@1.6.4
Vite & Vue powered static site generator (vuejs/vitepress). Source of truth in
this Skill is the prepared package source; line citations are relative to the
package root (for example dist/node/index.d.ts:2382).
Version facts
- Version 1.6.4, MIT (
package.json:3). - Bundles Vue
^3.5.13, Vite^5.4.14, shiki^2.1.0, minisearch^7(package.json:59-78). - Requires Node.js 18+ (https://vitepress.dev/guide/getting-started).
- VitePress v1 is not compatible with
rolldown-vite; the dev server prints an error and directs to VitePress v2 (dist/node/cli.js:438-444). - Optional peers:
markdown-it-mathjax3(formarkdown.math),postcss(package.json:155-166).
Entry points
Defined by the export map in package.json:18-37:
| Import | Types entry | Use for |
vitepress | types/index.d.ts | Node + client + shared API, config helpers |
vitepress/client | client.d.ts | Client composables (useData, useRouter, …) |
vitepress/theme | theme.d.ts | Default theme, useSidebar, useLocalNav |
vitepress/theme-without-fonts | theme-without-fonts.d.ts | Default theme without bundled font files |
CLI binary: vitepress → bin/vitepress.js.
Setup and commands
npm add -D vitepress
npx vitepress init
npx vitepress dev
npx vitepress build
npx vitepress previewdev may be omitted when using the current directory (vitepress alone).
serve is an alias of preview. Full flags and dev shortcuts:
cli.md
Common tasks
Site config (.vitepress/config.ts)
import { defineConfig } from 'vitepress'
export default defineConfig({
title: 'My App',
description: 'A VitePress site',
themeConfig: {
nav: [{ text: 'Guide', link: '/guide/' }],
sidebar: [{ text: 'Guide', items: [{ text: 'Intro', link: '/guide/intro' }] }]
}
})defineConfig is typed for the default theme; use
defineConfigWithTheme<CustomThemeConfig> for a custom theme
(dist/node/index.d.ts:2382-2386). Every option:
site-config.md
Client runtime API
<script setup>
import { useData, useRouter, withBase } from 'vitepress'
const { page, frontmatter, isDark, hash } = useData()
const router = useRouter()
</script>Full export list and signatures: api.md
Build-time data loading
// posts.data.js
import { createContentLoader } from 'vitepress'
export default createContentLoader('posts/*.md', { excerpt: true })Import as import { data } from './posts.data.js'. Runs in Node only; the
result ships as JSON in the client bundle.
Browser-only components
<script setup>
import { defineClientComponent } from 'vitepress'
const Chart = defineClientComponent(() => import('./Chart.vue'))
</script>Prevents SSG build failures when a library touches window/document on
import (https://vitepress.dev/guide/ssr-compat).
Best practices
- Use
createContentLoaderfor archive and index pages instead of hand-rolled loaders; it caches by file mtime and keeps the client JSON small (dist/node/index.d.ts:2466-2473, https://vitepress.dev/guide/data-loading). - Wrap browser-only components with
defineClientComponent(https://vitepress.dev/guide/ssr-compat). - Keep image and asset URLs relative in Markdown so Vite hashes and inlines
them; use
withBase()for dynamic paths in theme components (https://vitepress.dev/guide/asset-handling). - Enable
cleanUrls: trueonly when the host can map/footo/foo.html(https://vitepress.dev/guide/routing#clean-urls). - With
rewrites, relative links must target the rewritten URL structure, not the source file structure (https://vitepress.dev/guide/routing#route-rewrites). - In dynamic route
paths.jsloaders, pass large payloads viacontent, notparams, to keep client JS small (https://vitepress.dev/guide/routing#dynamic-routes). - In MPA mode (
mpa: true), use<script client>for interactivity; plain<script setup>is server-side templating only (https://vitepress.dev/guide/mpa-mode). - Exclude pages from local search with the
_renderhook (types/default-theme.d.ts:451-455).
Deeper references
- api.md: every export from
vitepress,vitepress/client,vitepress/theme, data loader types, theme interface. - site-config.md:
UserConfigfields, build hooks,SiteConfig,mergeConfig. - default-theme.md:
DefaultTheme.Config, nav, sidebar, search (local and algolia), theme extension. - markdown.md:
markdownoptions, shiki setup, containers, math,createMarkdownRenderer. - cli.md: commands, flags, dev shortcuts, scaffolding.
- migration.md: v0 → v1 breaking changes and deprecations still visible in 1.6.4.
Version-specific changes
Prioritize these when touching old configs; details and citations in migration.md:
- BREAKING (v1.0.0-rc.9):
pathname://protocol removed; usetarget="_self"ortarget="_blank"(https://github.com/vuejs/vitepress/blob/main/CHANGELOG.md). - BREAKING (v1.0.0): sidebar
childrenrenamed toitems; top-level items no longer acceptlink(https://vitepress.dev/guide/migration-from-vitepress-0). - BREAKING (v1.0.0-alpha.44):
collapsiblereplaced bycollapsed: boolean(CHANGELOG). - BREAKING (v1.0.0-alpha.57):
markdown.headersdisabled by default;PageData.headersis empty unless enabled (CHANGELOG). - When
markdown.headersis enabled, extraction levels default to[2, 3](dist/node/index.d.ts:1769-1786). - NEW (v1.1.0):
useData().hashreactive URL hash (dist/client/index.d.ts:79-83). - NEW (v1.4.0):
onAfterPageLoadrouter hook (dist/client/index.d.ts:36-38). - NEW (v1.3.0):
appearance: 'force-auto'(types/shared.d.ts:119-124). - Deprecated in 1.6.4:
Theme.setup,Theme.NotFound(dist/client/index.d.ts:96-103),outlineTitle,lastUpdatedText,algoliatheme options (types/default-theme.d.ts:36-77,139-141).
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

