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
1. Price: vitepress.dev
Fully free.
vitepress.devNo quote yet: price is read from the official pages.
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.com3. Credit the author: raw.githubusercontent.com
“The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.”
No credit on screen. Keep the license notice inside the code you ship.
raw.githubusercontent.com4. Agent access: github.com/vuejs/vitepress
An agent can install it by itself with npm install vitepress. No key or account is needed.
github.com/vuejs/vitepressLicense 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
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
Run the setup wizard; it asks a few questions and creates a docs folder with a config file and sample pages.
$ npx vitepress init
Start the local preview and edit the text files; changes show up at once.
$ npm run docs:dev
Mistakes to avoid
const vitepress = require('vitepress') in a project without "type": "module"VitePress is published as ES modules only.
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 releasenpm add -D vitepress@1.6.4 (current latest), or pin the exact 2.0 alpha on purposeThe next tag points to a 2.0 alpha, while latest is 1.6.4.
They hold the dev server cache and the build output.
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.
“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
“The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.” 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” 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” raw.githubusercontent.com
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.
- 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/)
Agent installs a package or loads it from a CDN.
npm install vitepressFormats: md, vue
Alternatives
VitePress This page
Pick Starlight when your site is built with Astro and you want a docs template with navigation, search and translations.
Pick Docusaurus when you prefer React and want docs, a blog and a landing page in one classic template.
Pick Nextra when the rest of your project already runs on Next.js.
Official Bootstrap 5 example snippets and layouts: heroes, features, pricing, headers, footers, dashboards; one zip download.
Vue/Nuxt UI library (125+ components, Reka UI + Tailwind) with page-level components and MIT starter templates: landing, SaaS, docs, dashboard.
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.