Agent skill

Vitepress Skilld

by skilld-dev in skilld-dev/vue-ecosystem-skills

A skill your agent uses when writing, configuring, or debugging code that imports "vitepress", when running vitepress CLI commands, editing .vitepress/config or theme files, tuning markdown or…

MITAuto-check passedFrontend & Design

Install Vitepress Skilld

skills CLI
$ npx skills add skilld-dev/vue-ecosystem-skills --skill vitepress-skilld -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install skilld-dev/vue-ecosystem-skills vitepress-skilld --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/skilld-dev/vue-ecosystem-skills.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/vitepress-skilld .claude/skills/vitepress-skilld && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
vitepress-skilld
GitHub stars
181
Token cost
~1.7k tokens
SKILL.md length
499 words
Files
7 (incl. references)
Skills in repo
34
Repo updated
First seen
Licence
MIT

At a glance

A skill your agent uses when writing, configuring, or debugging code that imports "vitepress", when running vitepress CLI commands, editing .vitepress/config or theme files, tuning markdown or…

  • Debugging code that imports vitepress
  • SKILL.md covers Version facts, Entry points, Setup and commands and Common tasks, plus 3 more sections
  • Calls npx and npm
  • Running vitepress CLI commands

What it does

Vitepress Skilld is an agent skill from skilld-dev/vue-ecosystem-skills. 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.

Its SKILL.md is about 1.7k tokens, which your agent loads only when the skill is triggered. The skill folder holds 7 other files, including reference files (for example `references/api.md`, `references/cli.md` and `references/default-theme.md`).

It sits in Frontend & Design, covering Static sites and blogs. It works with VitePress, Vue.js, npm and Vite. The repository describes itself as: Agent Skills for the Vue ecosystem, written from current docs, issues, and releases. The licence is MIT.

When your agent uses it

  • Debugging code that imports vitepress
  • Running vitepress CLI commands
  • Editing .vitepress/config
  • Tuning markdown

Example prompts

  • “vitepress”
  • “/vitepress-skilld”

Requirements

  • Node.js

What it can do on your machine

Read from SKILL.md and the folder at commit c8994af. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • npx
    • npm

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Links to these hosts (documentation or services it may open):

    • vitepress.dev
    • github.com

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Vitepress Skilld loads about 1.7k tokens when it runs, and up to ~8.3k if it reads all its reference files. Until then it costs about 89 tokens; SKILL.md has 499 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~89
When it runs · the whole SKILL.md, loaded when a task matches
~1.7k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~8.3k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from skilld-dev/vue-ecosystem-skills at commit c8994af, republished under its MIT licence (© skilld-dev). 499 words, ~1,706 tokens.

Download SKILL.mdSave it as .claude/skills/vitepress-skilld/SKILL.md (or your agent's skills folder). This skill also uses 6 other files; get the full folder from GitHub.
name
vitepress-skilld
description
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.

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 (for markdown.math), postcss (package.json:155-166).

Entry points

Defined by the export map in package.json:18-37:

ImportTypes entryUse for
vitepresstypes/index.d.tsNode + client + shared API, config helpers
vitepress/clientclient.d.tsClient composables (useData, useRouter, …)
vitepress/themetheme.d.tsDefault theme, useSidebar, useLocalNav
vitepress/theme-without-fontstheme-without-fonts.d.tsDefault theme without bundled font files

CLI binary: vitepress → bin/vitepress.js.

Setup and commands

sh
npm add -D vitepress
npx vitepress init
npx vitepress dev
npx vitepress build
npx vitepress preview

dev 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)
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
vue
<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
ts
// 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
vue
<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

Show full SKILL.md (154 more words)Show less

Deeper references

  • api.md: every export from vitepress, vitepress/client, vitepress/theme, data loader types, theme interface.
  • site-config.md: UserConfig fields, build hooks, SiteConfig, mergeConfig.
  • default-theme.md: DefaultTheme.Config, nav, sidebar, search (local and algolia), theme extension.
  • markdown.md: markdown options, 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; use target="_self" or target="_blank" (https://github.com/vuejs/vitepress/blob/main/CHANGELOG.md).
  • BREAKING (v1.0.0): sidebar children renamed to items; top-level items no longer accept link (https://vitepress.dev/guide/migration-from-vitepress-0).
  • BREAKING (v1.0.0-alpha.44): collapsible replaced by collapsed: boolean (CHANGELOG).
  • BREAKING (v1.0.0-alpha.57): markdown.headers disabled by default; PageData.headers is empty unless enabled (CHANGELOG).
  • When markdown.headers is enabled, extraction levels default to [2, 3] (dist/node/index.d.ts:1769-1786).
  • NEW (v1.1.0): useData().hash reactive URL hash (dist/client/index.d.ts:79-83).
  • NEW (v1.4.0): onAfterPageLoad router 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, algolia theme options (types/default-theme.d.ts:36-77,139-141).

© skilld-dev, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 6 other files (references) in skills/vitepress-skilld of skilld-dev/vue-ecosystem-skills.

  • SKILL.md
  • references/api.md
  • references/cli.md
  • references/default-theme.md
  • references/markdown.md
  • references/migration.md
  • references/site-config.md

Open the folder on GitHubat commit c8994af

Compare with similar skills

Vitepress Skilld next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Vitepress Skilld compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Vitepress Skilld this skillskilld-dev/vue-ecosystem-skills181—~1.7kAutomated safety check: PassMIT
Oryxos Admin UIoryx-labs/oryxos186—~913Automated safety check: PassApache-2.0
VitepressJetBrains/skills3647 repos~798Automated safety check: PassNone
Create Docsvictorgarciaesgi/nuxt-typed-router4132 repos~2.8kAutomated safety check: PassMIT
Nuxt UImegaarmos/vue-spring-bottom-sheet1411 repos~2.5kAutomated safety check: PassMIT
Vuetify Skilldlogue/vite-vuetify-ts-starter1811 repos~1.9kAutomated safety check: PassMIT

Similar skills

  • Oryxos Admin UI

    oryx-labs/oryxos

    生成或扩展 OryxOS 的 Web 管理台(web manager)前端——Vue 3 + Vite 单页应用,视觉与官网首页 (website/,VitePress)完全同源:深色底 + 橙色主色、Inter/JetBrains Mono。内置这套设计 token、 工程约定(base '/admin/'、产物落 oryxos-web static/admin、SPA…

    186 GitHub stars~913 tokensUpdated yesterday
    Frontend & DesignAuto-check passed
  • Vitepress

    JetBrains/skills

    Official

    VitePress static site generator powered by Vite and Vue. An agent skill from JetBrains/skills.

    364 GitHub starsUsed in 7 repos~798 tokens
    Frontend & DesignAuto-check passed
  • Create Docs

    victorgarciaesgi/nuxt-typed-router

    Create complete documentation sites for projects. An agent skill from victorgarciaesgi/nuxt-typed-router.

    413 GitHub starsUsed in 2 repos~2.8k tokens
    Frontend & DesignAuto-check passed
  • Nuxt UI

    megaarmos/vue-spring-bottom-sheet

    Build UIs with @nuxt/ui v4 — 125+ accessible Vue components with Tailwind CSS theming.

    141 GitHub starsUsed in 1 repo~2.5k tokens
    Frontend & DesignAuto-check passed
  • Vuetify Skilld

    logue/vite-vuetify-ts-starter

    Vue Material Component Framework. An agent skill from logue/vite-vuetify-ts-starter.

    181 GitHub starsUsed in 1 repo~1.9k tokens
    Frontend & DesignAuto-check passed
  • Glide Setup

    SrivarsanK/Glide

    Zero-error setup guide for AI agents to install and configure @srivarsank/glide visual editor on any React, Vue, Svelte, Astro, or HTML Vite project in one prompt.

    125 GitHub stars~868 tokensUpdated 8 days ago
    Frontend & DesignAuto-check passed

More from skilld-dev/vue-ecosystem-skills

All 34 skills in this repo
  • Floating UI Vue Skilld

    skilld-dev/vue-ecosystem-skills

    Floating UI for Vue (@floating-ui/vue@2.0.1). An agent skill from skilld-dev/vue-ecosystem-skills.

    181 GitHub stars~1.3k tokensUpdated 16 days ago
    Auto-check passed
  • Formkit Core Skilld

    skilld-dev/vue-ecosystem-skills

    A skill your agent uses whenever writing, debugging, or reviewing code that imports @formkit/core — FormKit's framework-agnostic core (node trees, values, events, hooks, message stores, ledgers…

    181 GitHub stars~2.1k tokensUpdated 16 days ago
    Auto-check passed
  • Pinia Colada Skilld

    skilld-dev/vue-ecosystem-skills

    Data fetching layer for Vue built on Pinia. An agent skill from skilld-dev/vue-ecosystem-skills.

    181 GitHub stars~1.9k tokensUpdated 16 days ago
    Auto-check passed
  • Pinia Skilld

    skilld-dev/vue-ecosystem-skills

    A skill your agent uses when writing, debugging, or refactoring code that imports "pinia", the Vue 3 store library.

    181 GitHub stars~1.5k tokensUpdated 16 days ago
    Auto-check passed
  • Primevue Skilld

    skilld-dev/vue-ecosystem-skills

    A skill your agent uses when writing, debugging, or updating code that imports primevue (PrimeVue v5, UI component library for Vue 3).

    181 GitHub stars~1.9k tokensUpdated 16 days ago
    Auto-check passed
  • Quasar Skilld

    skilld-dev/vue-ecosystem-skills

    Build, configure, and debug apps with the Quasar framework (quasar npm package, v2.33.1).

    181 GitHub stars~1.6k tokensUpdated 16 days ago
    Auto-check passed

Questions about Vitepress Skilld

What does Vitepress Skilld do?

A skill your agent uses when writing, configuring, or debugging code that imports "vitepress", when running vitepress CLI commands, editing .vitepress/config or theme files, tuning markdown or…. Vitepress Skilld is an agent skill from skilld-dev/vue-ecosystem-skills.vitepress/config or theme files, tuning markdown or default theme options, or migrating a VitePress site.

When should I use Vitepress Skilld?

Vitepress Skilld fits situations like: debugging code that imports vitepress; running vitepress CLI commands; editing .vitepress/config; tuning markdown.

How do I install Vitepress Skilld in Claude Code?

Run `npx skills add skilld-dev/vue-ecosystem-skills --skill vitepress-skilld -a claude-code`. Or copy the skill folder (skills/vitepress-skilld in skilld-dev/vue-ecosystem-skills) into .claude/skills/vitepress-skilld in your project. Claude Code loads it when a task matches its description.

How do I install Vitepress Skilld in Codex?

Run `npx skills add skilld-dev/vue-ecosystem-skills --skill vitepress-skilld -a codex`. Or copy the skill folder (skills/vitepress-skilld in skilld-dev/vue-ecosystem-skills) into .agents/skills/vitepress-skilld in your project. Codex loads it when a task matches its description.

Can I use Vitepress Skilld in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add skilld-dev/vue-ecosystem-skills --skill vitepress-skilld -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/vitepress-skilld, .gemini/skills/vitepress-skilld, .github/skills/vitepress-skilld and .opencode/skills/vitepress-skilld in your project.

What does Vitepress Skilld need to run?

Going by SKILL.md and its folder, Vitepress Skilld needs the command-line tools its instructions call (npx and npm). Our summary lists: Node.js.

Does Vitepress Skilld access the network?

SKILL.md names 2 domains. As links in the text: vitepress.dev and github.com. This is read from the text; nothing was executed.

Is Vitepress Skilld safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Vitepress Skilld use?

Vitepress Skilld is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Vitepress Skilld use?

About 1.7k tokens (SKILL.md is roughly 6.8k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 6.6k tokens, read only when the agent opens those files.

What are the alternatives to Vitepress Skilld?

Skills that share tags, products or a category with Vitepress Skilld: Oryxos Admin UI (oryx-labs/oryxos, 186 stars), Vitepress (JetBrains/skills, 364 stars), Create Docs (victorgarciaesgi/nuxt-typed-router, 413 stars) and Nuxt UI (megaarmos/vue-spring-bottom-sheet, 141 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Vitepress Skilld?

skilld-dev (a GitHub organization) maintains it in skilld-dev/vue-ecosystem-skills, which has 181 GitHub stars. The repository holds 34 skills in this directory. The repository was last updated on September 22, 2026.

Source: skilld-dev/vue-ecosystem-skills on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.