# VitePress — card for AI agents

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

Category: Page and site templates · maker Vue.js · checked 2026-11-09 · style: minimal

## Price
- Price: Free
- Free tier: Fully free.

## License
MIT — https://raw.githubusercontent.com/vuejs/vitepress/main/LICENSE

- commercial: **yes** (Commercial use OK)
  > 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
  (https://raw.githubusercontent.com/vuejs/vitepress/main/LICENSE)
- attribution: **no** (No credit needed)
  > The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  (https://raw.githubusercontent.com/vuejs/vitepress/main/LICENSE)
- in app: **yes** (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
  (https://raw.githubusercontent.com/vuejs/vitepress/main/LICENSE)
- redistribute: **yes** (Can pass the files on to your own users)
  > 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
  (https://raw.githubusercontent.com/vuejs/vitepress/main/LICENSE)

## Rules to follow
- Keep the MIT copyright notice in the code if you redistribute it.
- No visible credit on the site is required by the licence.

## Can an AI agent use it by itself?
**Yes** · package: Agent installs a package or loads it from a CDN

## How an agent gets files
- npx vitepress init (setup wizard); no account. (sign-in: none)
- Formats: md, vue
- Not allowed: Needs Node.js

## How to connect
- Package (npm/PyPI)
- npm: `npm install vitepress`
- Repository: https://github.com/vuejs/vitepress
- Website: https://vitepress.dev

## Numbers (AgentGid data)
- Gid Score: 57
- GitHub stars: 18,500
- Downloads last week: 1,980,108
- Used in 20 public projects set up for AI coding agents

## Lines to paste 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/)
```

## Links
- AgentGid page: https://agentgid.com/assets/vitepress/
- Is it free for commercial use? https://agentgid.com/assets/vitepress/commercial-use/
- Source: https://vitepress.dev
- Source: https://github.com/vuejs/vitepress
- Source: https://raw.githubusercontent.com/vuejs/vitepress/main/LICENSE


## 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 to 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: Publish the finished pages on GitHub Pages or a similar free host and let search engines find every page through a sitemap file. (idea, not from the official pages)

### How to start
- 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
```


### 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.

### Good to know
- You need Node.js on your computer or build server. The current docs ask for version 22 or newer.
- The website docs now describe the 2.0 test version, installed as vitepress@next. The newest stable release is 1.6.4, and its own guide asks for Node.js 18 or newer.
- Pages are made once when you build the site. Content that changes for each visitor needs a different tool or your own code.
- Search through Algolia needs keys from your own Algolia DocSearch setup; the built-in local search needs nothing.

Checked 2026-11-09 against: https://vitepress.dev/, https://vitepress.dev/llms.txt, https://vitepress.dev/guide/what-is-vitepress.md, https://vitepress.dev/guide/getting-started.md, https://vitepress.dev/guide/deploy.md, https://vitepress.dev/guide/i18n.md, https://vitepress.dev/guide/routing.md, https://vitepress.dev/guide/sitemap-generation.md, https://vitepress.dev/guide/ssr-compat.md, https://vitepress.dev/guide/using-vue.md, https://vitepress.dev/reference/default-theme-home-page.md, https://vitepress.dev/reference/default-theme-search.md, https://github.com/vuejs/vitepress, https://github.com/vuejs/vitepress/blob/main/LICENSE, https://github.com/vuejs/vitepress/blob/v1.6.4/docs/en/guide/getting-started.md, https://registry.npmjs.org/vitepress, https://registry.npmjs.org/vitepress/1.6.4

### Mistakes to avoid
- Don't: const vitepress = require('vitepress') in a project without "type": "module" → Do: Use import, add "type": "module" to package.json, or name the config .vitepress/config.mts (VitePress is published as ES modules only.)
- Don't: Publishing to user.github.io/repo/ with the default base → Do: Set base: '/repo/' in the VitePress config (Without it, styles and links point to the domain root and the site looks broken.)
- Don't: npm add -D vitepress@next copied from the docs into a project that needs a stable release → Do: 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.)
- Don't: Committing .vitepress/cache and .vitepress/dist to Git → Do: Add both folders to .gitignore and build on the host (They hold the dev server cache and the build output.)
- Don't: Using window or document at the top of a custom theme component → Do: 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.)

### 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.

---
AgentGid's catalog is curated: every entry was checked against the maker's official pages (registry, repository, license and pricing pages) on the date shown; a license value shows the quote it stands on wherever AgentGid has one. Usage numbers come from AgentGid's own scan of public repositories set up for AI coding agents. Claims by makers are reported, not tested by AgentGid.
