mirror of
https://github.com/wahyd4/vuepress.git
synced 2026-08-11 22:36:59 +10:00
35 lines
853 B
Markdown
35 lines
853 B
Markdown
---
|
|
home: true
|
|
heroImage: /hero.png
|
|
actionText: Get Started →
|
|
actionLink: /guide/
|
|
features:
|
|
- title: Simplicity First
|
|
details: Minimal setup with markdown-centered project structure helps you focus on writing.
|
|
- title: Vue-Powered
|
|
details: Enjoy the dev experience of Vue + webpack, use Vue components in markdown, and develop custom themes with Vue.
|
|
- title: Performant
|
|
details: VuePress generates pre-rendered static HTML for each page, and runs as an SPA once a page is loaded.
|
|
footer: MIT Licensed | Copyright © 2018-present Evan You
|
|
---
|
|
|
|
### As Easy as 1, 2, 3
|
|
|
|
``` bash
|
|
# install
|
|
yarn global add vuepress # OR npm install -g vuepress
|
|
|
|
# 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.
|
|
:::
|