vuepress README

The project's README from github.com/vuejs/vuepress. As one markdown file: README.md.

logo

Downloads Version License VuePress channel on Discord

Status

VuePress v1 is now in maintenance mode.

For a next-gen Vue-based SSG:

Documentation

Check out our docs at https://vuepress.vuejs.org/.

Showcase

Contribution

Want to contribute? Check our Contributing Guide and issues for beginners!

yarn install # install all dependencies
yarn dev  # serves VuePress' own docs with itself
yarn test # make sure your code change pass the test

If you don't have a local checkout, you can also open VuePress in Gitpod, a free online IDE for GitHub.

If you intend to make "substantial" changes to VuePress or its documentation, please checkout VuePress RFCs.

If you have a VuePress-related project/component/tool, add it with a pull request to this curated list!

Contributors

Creator / Lead

Evan You
Evan You

💻
ULIVZ
ULIVZ

💻 📖

Active Core Team

Billyyyyy3320
Billyyyyy3320

💻
meteorlxy
meteorlxy

💻
Ramona
Ramona

💻 📖
Franck Abgrall
Franck Abgrall

💻 💬

Core Team Emeriti

Here we honor some no-longer-active core team members who have made valuable contributions in the past.

Ben Hong
Ben Hong

💻 📖 💬
Giraud Florent
Giraud Florent

💻
Sarah Dayan
Sarah Dayan

💻 📖
Vinayak Kulkarni
Vinayak Kulkarni

🔌 💻 📝
Victoria Bergquist
Victoria Bergquist

💻 🎨
Nikita Sobolev
Nikita Sobolev

💻 📖
Fatih Acet
Fatih Acet

💻
Vladimir Pouzanov
Vladimir Pouzanov

💻

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

License

MIT

vuepress (vuejs/vuepress)

Searching Database…

22.7K ·GitHub
What is this?VuePress is a minimalistic static site generator powered by Vue: it turns your content into fast static websites, most often used for documentation sites and blogs.
Is it a library I code against, or a tool that builds a whole website?It is a generator, not a component library: you run a build over your content and get a complete static site you can host anywhere; Vue is what renders the pages.
How do I get it running?The README links to the official documentation for installation and getting started. The tooling is Node-based, so everything runs through npm or yarn in a terminal.
The README mentions maintenance mode — which version should a new site use?v1 is maintenance-only. For new projects the README recommends either VitePress, the Vue team's official next-gen SSG on Vue 3 + Vite, or VuePress v2+, which is community-supported and runs on Vue 3 with Vite, Webpack, or other bundlers.
What do people typically build with it?Documentation sites and blogs are the core use cases; the repo's own topics are blog-engine, docs-generator, and seo, on top of static-site-generator.
Where can I see real sites built with VuePress?The README's Showcase section lists Awesome VuePress, a curated list of VuePress projects, and vuepress.tools, a directory maintained by Ahmad Mostafa.
Is the generated output good for SEO?SEO is one of the project's own focus tags, and since pages are pre-built as static HTML, search engines can index them without executing JavaScript.
Can I explore or change the source without a local setup?Yes — the README suggests opening VuePress in Gitpod, a free online IDE for GitHub, straight from the repo. Substantial changes to the code or docs go through VuePress RFCs first.
Creator
vuejs
Size
14.3 MB
Stars
22.7K
Age
8y
Commits · 90 Days