DEV Community

Alex Spinov
Alex Spinov

Posted on

VitePress Has a Free API — Static Sites Powered by Vite and Vue

#vue #documentation #webdev #javascript

What if your documentation site loaded instantly, supported Vue components in Markdown, and built in seconds instead of minutes?

VitePress is the next-generation static site generator from the Vue ecosystem, powered by Vite.

Why VitePress

VuePress was great but slow to build. VitePress is a complete rewrite:

  • Instant dev server — powered by Vite, starts in milliseconds
  • Vue 3 in Markdown — use any Vue component directly in your docs
  • Near-instant builds — 100x faster than VuePress
  • Default theme — beautiful, responsive, dark mode out of the box
  • Full-text search — built-in local search, no external service needed

Quick Start 

npx vitepress init
npm run docs:dev
Enter fullscreen mode Exit fullscreen mode

Write docs in Markdown:

---
outline: deep
---

# My API Reference

## Installation
Enter fullscreen mode Exit fullscreen mode


bash
npm install my-sdk


## Usage
Enter fullscreen mode Exit fullscreen mode


ts
import { createClient } from 'my-sdk'
const client = createClient({ apiKey: 'xxx' })

Enter fullscreen mode Exit fullscreen mode


vue

Vue Components in Markdown 

<script setup>
import { ref } from 'vue'
const count = ref(0)
</script>

# Interactive Demo

Click count: {{ count }}

<button @click="count++">Increment</button>
Enter fullscreen mode Exit fullscreen mode

Your documentation becomes interactive. Live code demos, API playgrounds, interactive examples — all in Markdown files.

Built-in Search

VitePress includes MiniSearch — full-text search that works entirely client-side. No Algolia setup, no API keys, no external dependencies.

Deploy Anywhere 

npm run docs:build
# Output in .vitepress/dist — deploy to any static host
Enter fullscreen mode Exit fullscreen mode

Works with GitHub Pages, Netlify, Vercel, Cloudflare Pages — any static hosting.

Real Use Case

A component library team maintained docs with Storybook + a custom Gatsby site. Build times hit 8 minutes. After migrating to VitePress, builds dropped to 12 seconds. Vue components rendered directly in docs — no iframe embedding needed. The team deleted 2,000 lines of custom build configuration.

When to Use VitePress

  • Vue ecosystem documentation
  • Technical documentation that needs interactive examples
  • Fast-building static sites
  • Teams already using Vite

Get Started

Visit vitepress.dev — open source, MIT licensed, built by the Vue team.

Need custom data pipelines or scraping solutions? Check out my Apify actors or email me at spinov001@gmail.com for custom solutions.

Top comments (0)