Skip to content
Agents tracked: 502 Releases (7d): 613 Agent status: 4 with issuesSince last limit reset: Claude 7d · Codex 5d For AI agents: Markdown Updated Nov 18, 2026

VitePress

by Vue.js

Vite + Vue static site generator with a default docs theme and a home/landing layout.

Page and site templates Code libraryOpen sourceminimal

GitHub repoWebsite

2. Commercial use: raw.githubusercontent.com

“Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software”

MIT allows use in paid products and client sites free of charge.

raw.githubusercontent.com

License checked Nov 9, 2026 against 1 official page. Tap a verdict to see its source. How we checked Report an error

VitePress: a docs site from plain text files

VitePress turns a folder of simple Markdown text files into a fast, finished website. It comes with a ready design for documentation, with a menu, sidebar, search and dark mode, plus a home page with a big headline and feature boxes. The result is plain web pages you can host almost anywhere, often for free.

Where you can use it

Documentation for your product

Write help pages and guides as text files and get a docs site with a sidebar, page links and code examples that look tidy.

Search inside your docs

Visitors search all pages from a box at the top. The search runs in their browser, with no outside service or account.

A landing page for a project

Give a library or app a front page with a big headline, buttons and a row of feature boxes. It is set up in a few lines at the top of one file.

A blog or portfolio

Use your own design on top of the same engine for a blog, a portfolio or a small marketing site.

Docs in several languages

Keep each language in its own folder, such as es or fr, and visitors switch between them from the menu.

Free hosting with a sitemap Idea

Publish the finished pages on GitHub Pages or a similar free host and let search engines find every page through a sitemap file.

VitePress popularity

57 / 100
Gid Score, same scale as developer tools
18,500
GitHub stars
2M
npm downloads, last 7 days
+35.3% in 4 weeks
20
AI-agent projects using it, from our repo scan of 4,817
VitePress: downloads per weeknpm, vitepress 1,969,605
VitePress: GitHub starsvuejs/vitepress 18,500

Downloads from api.npmjs.org, stars from GitHub, checked Nov 15, 2026. How the Gid Score is calculated

How to start

Tell your AI assistant

“Add VitePress 1.6.4 to this project in a docs folder, set the site title and description, turn on local search and a sitemap for https://example.com, and set base to '/repo/' for GitHub Pages.”

Show codeStep 1 or Step 2 or Step 3

Make sure Node.js is installed (version 22 or newer for the version the current docs describe), then add VitePress to the project.

$ npm add -D vitepress@next

Mistakes to avoid

const vitepress = require('vitepress') in a project without "type": "module"
Use import, add "type": "module" to package.json, or name the config .vitepress/config.mts

VitePress is published as ES modules only.

Publishing to user.github.io/repo/ with the default base
Set base: '/repo/' in the VitePress config

Without it, styles and links point to the domain root and the site looks broken.

npm add -D vitepress@next copied from the docs into a project that needs a stable release
npm add -D vitepress@1.6.4 (current latest), or pin the exact 2.0 alpha on purpose

The next tag points to a 2.0 alpha, while latest is 1.6.4.

Committing .vitepress/cache and .vitepress/dist to Git
Add both folders to .gitignore and build on the host

They hold the dev server cache and the build output.

Using window or document at the top of a custom theme component
Touch browser objects only in onMounted / mounted, or wrap the component in <ClientOnly>

Pages are pre-rendered in Node.js during the build, where the browser objects do not exist.

License

MIT license. Free for personal and paid sites, and no visible credit on the site is needed. Keep the copyright and license notice if you pass the VitePress code itself on.

Commercial use
Yes

“Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software” raw.githubusercontent.com

Credit
Not needed

“The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.” raw.githubusercontent.com

Inside your app or game
Can ship inside your app

“Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software” raw.githubusercontent.com

Pass the files on to your users
Allowed

“Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software” raw.githubusercontent.com

AI training
Not stated
Bots and bulk downloads
Not stated

AllowedWith conditionsNot allowedNot stated or not checked yet

Is VitePress free for commercial use? The full answer Not legal advice. Check the license page before you ship.

For your agent

License rules tell your agent what it may do with VitePress. Paste them into your prompt or AGENTS.md.

License rules
- VitePress (Page and site templates). Vite + Vue static site generator with a default docs theme and a home/landing layout. Price: free; commercial use OK; no credit needed. Style: minimal.
  Connect: npm vitepress.
  Get files: npx vitepress init (setup wizard); no account (md, vue).
  Not allowed: Needs Node.js
  Rule: Keep the MIT copyright notice in the code if you redistribute it.
  Rule: No visible credit on the site is required by the licence.
  License: https://raw.githubusercontent.com/vuejs/vitepress/main/LICENSE (checked 2026-11-09; details: https://agentgid.com/assets/vitepress/)
Can an agent use it by itself?
Yes.

Agent installs a package or loads it from a CDN.

Install
npm install vitepress
How an agent gets files
npx vitepress init (setup wizard); no account.

Formats: md, vue

Repository
API, key or account
Not needed. Everything runs on your side.
MCP server
None found
This card for machines

Alternatives

VitePress This page

Free Commercial OK npm

Starlight

Pick Starlight when your site is built with Astro and you want a docs template with navigation, search and translations.

Free Commercial OK npm

Docusaurus

Pick Docusaurus when you prefer React and want docs, a blog and a landing page in one classic template.

Free Commercial OK npm

Nextra

Pick Nextra when the rest of your project already runs on Next.js.

Free Commercial OK npm

Bootstrap Examples

Official Bootstrap 5 example snippets and layouts: heroes, features, pricing, headers, footers, dashboards; one zip download.

Free Commercial OK npm

Nuxt UI

Vue/Nuxt UI library (125+ components, Reka UI + Tailwind) with page-level components and MIT starter templates: landing, SaaS, docs, dashboard.

Free Commercial OK npm

All page and site templates

Questions

Do I need to know how to code?

Not for writing pages; they are Markdown text files. Setting it up and publishing needs Node.js and a few terminal commands, which an AI assistant can run.

Where can I host the site?

Anywhere that serves plain web pages; the docs have guides for Netlify, Vercel, Cloudflare Pages, GitHub Pages, GitLab Pages and others.

Does it have search?

Yes. A local search that runs in the visitor's browser is built in, and Algolia DocSearch is supported.

Can I use it for a commercial product's docs?

Yes. It is MIT licensed, and no credit on the site is required.

Can I add interactive parts to a page?

Yes. Every Markdown page can also hold Vue components, so you can embed small interactive pieces.