VitePress website screenshot

VitePress

VitePress is a Vite and Vue powered static site generator widely used for developer documentation. It converts Markdown content into fast, beautiful documentation sites with support for Vue components embedded directly in Markdown pages. VitePress ships a polished default theme with built-in dark mode, mobile-responsive layout, full-text local search, Algolia DocSearch integration, internationalization, and automatic sitemap generation. VitePress is the official documentation framework used by Vue, Vite, Rollup, Pinia, and many CNCF and open source projects.

VitePress publishes 2 APIs on the APIs.io network. Tagged areas include Documentation, Markdown, Open Source, Static Site Generator, and Vite.

The VitePress catalog on APIs.io includes 1 JSON-LD context and 1 Spectral governance ruleset.

VitePress’ developer surface includes documentation, GitHub presence, and 8 more developer resources.

🌐 Visit website 📡 Source on GitHub
31.6/100 thin ▬ flat Agent 3/100 human only Full breakdown ↓
scored 2026-08-05 · rubric v0.9.1
AccessFreemium
2 APIs
DocumentationMarkdownOpen SourceStatic Site GeneratorViteVue

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-08-05 · rubric v0.9.1
Composite quality — 31.6/100 · thin
Contract Quality 2.0 / 25
Developer Ergonomics 1.7 / 20
Commercial Clarity 7.9 / 20
Operational Transparency 4.8 / 13
Governance 8.3 / 12
Discoverability 6.9 / 10
Agent readiness — 3/100 · human only
Machine-Readable Contract 0 / 18
Agentic Access Contract 0 / 10
MCP Server 0 / 12
Machine-Readable Auth 0 / 10
Idempotency 0 / 9
Stable Error Semantics 0 / 8
Request/Response Examples 0 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 0 / 6
Agent Skills 0 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/vitepress: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 2

Individual APIs this provider publishes, each with its own machine-readable definition.

VitePress Runtime API

The VitePress Runtime API provides Vue composition functions and helper utilities for use in custom themes, Vue components, and Markdown pages. Key composables include useData()...

VitePress Site Configuration

The VitePress site configuration system exported from .vitepress/config.[js|ts]. Defines all settings controlling site metadata, routing, theming, Markdown processing, Vite and ...

Pricing Plans 1

Published pricing tiers and plan structures.

Vitepress Plans Pricing

3 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Vitepress Rate Limits

5 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Vitepress Finops

FINOPS

Semantic Vocabularies 1

JSON-LD contexts and semantic vocabularies used across these APIs.

Vitepress Context

0 classes · 9 properties

JSON-LD

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs.

VitePress API Rules

6 rules · 4 warnings 2 info

SPECTRAL

JSON Schema 2

Standalone JSON Schema definitions for this provider's data models.

VitePress Site Configuration

26 properties

JSON SCHEMA

VitePress Page Frontmatter

15 properties

JSON SCHEMA

JSON Structure 1

JSON Structure definitions describing this provider's data shapes.

Vitepress Config Structure

0 properties

JSON STRUCTURE

Examples 2

Example request and response payloads for these APIs.

Vitepress Config Example

5 fields

EXAMPLE

Vitepress Frontmatter Example

5 fields

EXAMPLE

Security Posture 1

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Vitepress Domain Security

TLSv1.3 · HSTS

SECURITY

Resources

Documentation 3

Reference material describing how the API behaves

Documentation
Documentation
 JSONSchema
JSONSchema
 JSONSchema
JSONSchema

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

LlmsText
LlmsText

Design & Contract 3

Pagination, idempotency, versioning, errors, and events

JSONLD
JSONLD
 JSONStructure
JSONStructure
 Vocabulary
Vocabulary

Build 1

SDKs, sample code, and the tooling you integrate with

GitHub
GitHub

Access & Security 1

Authentication, authorization, and security posture

DomainSecurity
DomainSecurity

Company 1

The organization behind the API

Website
Website

Source (apis.yml)

apis.yml Raw ↑ 
aid: vitepress
name: VitePress
description: VitePress is a Vite and Vue powered static site generator widely used for developer documentation. It converts
  Markdown content into fast, beautiful documentation sites with support for Vue components embedded directly in Markdown
  pages. VitePress ships a polished default theme with built-in dark mode, mobile-responsive layout, full-text local search,
  Algolia DocSearch integration, internationalization, and automatic sitemap generation. VitePress is the official documentation
  framework used by Vue, Vite, Rollup, Pinia, and many CNCF and open source projects.
type: Index
accessModel:
  pricing: freemium
  onboarding: unknown
  trial: false
  try_now: false
  public: false
  label: Freemium
  confidence: medium
  source:
  - plans
  generated: '2026-07-22'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/vitepress.png
tags:
- Documentation
- Markdown
- Open Source
- Static Site Generator
- Vite
- Vue
url: https://raw.githubusercontent.com/api-evangelist/vitepress/refs/heads/main/apis.yml
created: '2026-03-18'
modified: '2026-05-03'
specificationVersion: '0.19'
apis:
- aid: vitepress:runtime-api
  name: VitePress Runtime API
  description: The VitePress Runtime API provides Vue composition functions and helper utilities for use in custom themes,
    Vue components, and Markdown pages. Key composables include useData() for accessing site and page metadata, useRoute()
    for current route information, useRouter() for programmatic navigation, and withBase() for base URL resolution. Components
    include Content for rendering compiled Markdown and ClientOnly for browser-only rendering.
  humanURL: https://vitepress.dev/reference/runtime-api
  baseURL: https://vitepress.dev
  tags:
  - API
  - Composables
  - Documentation
  - JavaScript
  - Runtime
  - Vue
  properties:
  - type: Documentation
    url: https://vitepress.dev/reference/runtime-api
  - type: Reference
    url: https://vitepress.dev/reference/site-config
- aid: vitepress:site-config
  name: VitePress Site Configuration
  description: The VitePress site configuration system exported from .vitepress/config.[js|ts]. Defines all settings controlling
    site metadata, routing, theming, Markdown processing, Vite and Vue integration, and build hooks. Includes the default
    theme configuration for navigation, sidebar, search, social links, and internationalization.
  humanURL: https://vitepress.dev/reference/site-config
  baseURL: https://vitepress.dev
  tags:
  - Configuration
  - Documentation
  - Static Site
  - Theming
  properties:
  - type: Documentation
    url: https://vitepress.dev/reference/site-config
  - type: Reference
    url: https://vitepress.dev/reference/default-theme-config
common:
- type: DomainSecurity
  url: security/vitepress-domain-security.yml
- type: Website
  url: https://vitepress.dev
- type: Documentation
  url: https://vitepress.dev/guide/getting-started
- type: GitHub
  url: https://github.com/vuejs/vitepress
- type: JSONSchema
  url: json-schema/vitepress-config-schema.json
- type: JSONSchema
  url: json-schema/vitepress-frontmatter-schema.json
- type: JSONLD
  url: json-ld/vitepress-context.jsonld
- type: JSONStructure
  url: json-structure/vitepress-config-structure.json
- type: Vocabulary
  url: vocabulary/vitepress-vocabulary.yml
- type: LlmsText
  url: https://vitepress.dev/llms.txt
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com