Skip to content
Branch: master
Find file History

README.md

home heroImage actionText actionLink footer
true
/hero.png
Get Started →
/guide/
MIT Licensed | Copyright © 2018-present Evan You

Simplicity First

Minimal setup with markdown-centered project structure helps you focus on writing.

Vue-Powered

Enjoy the dev experience of Vue + webpack, use Vue components in markdown, and develop custom themes with Vue.

Performant

VuePress generates pre-rendered static HTML for each page, and runs as an SPA once a page is loaded.

As Easy as 1, 2, 3

# install
yarn global add vuepress@next 
# OR npm install -g vuepress@next

# create a markdown file
echo '# Hello VuePress' > README.md

# start writing
vuepress dev

# build to static files
vuepress build

::: warning COMPATIBILITY NOTE VuePress requires Node.js >= 8.6. :::

You can’t perform that action at this time.