mirror of
https://github.com/wahyd4/vuepress.git
synced 2026-08-27 14:15:52 +10:00
home, heroImage, actionText, actionLink, footer
| 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
::: warning
Note that this is the documentation of 1.x.x, if you are a 0.x.x user please go to: https://v0.vuepress.vuejs.org..
Since 1.x.x is still in the alpha stage, all APIs would change before we reach the rc stage, so do not use in production yet unless you are adventurous.
:::
# 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. :::