vitepress
Build and Configure VitePress Documentation Sites
VitePress projects require coordinated configuration, content, themes, data loading, and deployment. This skill provides focused guidance for building maintainable VitePress sites with Vue and Markdown.
Stop for confirmation before installing.
Review the plan and obtain explicit user consent before changing files.
Install with my Agent
Copy this request to your Agent. It includes the canonical Skill page and manifest.
Review the Skillstore skill "vitepress" from https://skillstore.io/skills/antfu-vitepress.md and its manifest at https://skillstore.io/api/skills/antfu-vitepress/manifest. Verify the artifact. Stop and obtain explicit user consent before installing or changing files.Your Agent should still show its plan and request any confirmation required by the security policy.
Agent-readable resources
Use these links when an AI agent, crawler, or script needs clean context instead of reading the full page.
Test it
Using "vitepress". Plan a small documentation site for a command-line application.
Expected outcome:
- Structure: introduction, installation, command reference, configuration, and troubleshooting.
- Navigation: Guide, Reference, and release repository.
- Sidebar: ordered learning pages followed by command and configuration references.
- Search: local search for a small self-contained site.
Using "vitepress". Recommend a deployment approach for documentation hosted under a repository subpath.
Expected outcome:
- Set the site base to the repository subpath.
- Build the documentation in continuous integration.
- Publish the generated VitePress distribution directory.
- Verify asset links and clean URLs in the deployed preview.
Using "vitepress". Review an SSR issue caused by a browser-only plugin.
Expected outcome:
Load the plugin only in the browser, use a fixed dynamic import, and wrap browser-dependent rendering in an appropriate client-only boundary.
Security Audit
High RiskAll 65 static findings are false positives from inert documentation examples, standard VitePress paths, placeholders, or Markdown formatting. No prompt injection or malicious intent was found. One separate example passes raw CMS content into generated pages without recommending validation or sanitization.
Confirmed security concerns (1)
Risk Factors
โ๏ธ External commands (8)
โก Contains scripts (7)
๐ Network access (16)
๐ Filesystem access (22)
๐ Env variables (1)
Share & cite this report
Share the versioned assessment report, neutral badge, embed card, and citations. Skillstore reports evidence without deciding whether this Skill is safe.
Copy report link
https://skillstore.io/skills/antfu-vitepress/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown badge
[](https://skillstore.io/skills/antfu-vitepress?utm_source=security_passport_badge)HTML badge
<a href="https://skillstore.io/skills/antfu-vitepress?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/antfu-vitepress/security.svg" alt="Skillstore security assessment" loading="lazy"></a>Embed card
<iframe src="https://skillstore.io/embed/skills/antfu-vitepress.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>Academic citations (APA ยท BibTeX ยท CFF)
APA citation
antfu. (2026). vitepress security audit report (audit version 5) [Author version 2026.1.28]. Skillstore. https://skillstore.io/skills/antfu-vitepress/audits/5BibTeX citation
@techreport{antfu-antfu-vitepress-2026,
author = {antfu},
title = {vitepress security audit report (audit version 5)},
institution = {Skillstore},
year = {2026},
number = {5},
url = {https://skillstore.io/skills/antfu-vitepress/audits/5},
note = {Author version 2026.1.28}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "vitepress security audit report (audit version 5)"
version: "2026.1.28"
type: report
authors:
- name: "antfu"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/antfu-vitepress/audits/5"
identifiers:
- type: other
value: "skillstore:antfu-vitepress:audit:5"
description: "Skillstore immutable audit report identifier"
Skillstore Score
Why this score Evidence Confidence: MediumWhat You Can Build
Create a Product Documentation Site
Plan routes, navigation, sidebars, search, and Markdown structure for a new product documentation site.
Extend a VitePress Theme
Add Vue components, theme slots, CSS variables, custom fonts, and SSR-safe browser integrations.
Prepare a Reliable Deployment
Choose build settings, base paths, output directories, and hosting configuration for a supported deployment platform.
Try These Prompts
Plan a VitePress site for [project]. Include the page structure, navigation, sidebar groups, search choice, and required setup steps.
Review my VitePress requirements for [site]. Propose configuration for metadata, clean URLs, navigation, sidebars, social links, and edit links.
Design VitePress data loaders and dynamic routes for [data source]. Explain file placement, watch patterns, route parameters, validation, and rendering.
Architect a multilingual VitePress site with a custom theme, SSR-safe browser plugins, remote content controls, and deployment to [platform].
Best Practices
- Inspect the existing VitePress configuration and theme extensions before proposing changes.
- Keep browser-only code behind SSR guards and use fixed module imports.
- Validate remote data, test production builds, and verify the configured base path before deployment.
Avoid
- Do not copy placeholder URLs, keys, paths, or package names into production unchanged.
- Do not render untrusted remote Markdown or HTML without validation and sanitization.
- Do not access browser globals during server rendering without a client-only boundary.
Frequently Asked Questions
Which VitePress version does this skill cover?
Can it create a complete VitePress configuration?
Does it support Vue components inside Markdown?
Can it help generate pages from data?
Does it deploy the site automatically?
How should remote HTML or Markdown be handled?
Developer Details
Author
antfuLicense
MIT
Author version
v2026.1.28
Skillstore revision
r2
Ref
89edfdc710d0846129dcee6a929477b04f08052c
Maintenance freshness
7/24/2026
Usage
8 downloads ยท 536 views
File structure
๐ GENERATION.md
๐ references/
๐ advanced-i18n.md
๐ advanced-ssr.md
๐ core-cli.md
๐ core-config.md
๐ core-markdown.md
๐ core-routing.md
๐ features-dynamic-routes.md
๐ features-vue.md
๐ recipes-deploy.md
๐ theme-config.md
๐ theme-custom.md
๐ SKILL.md