fes.js/docs/README.md

61 lines
1.2 KiB
Markdown
Raw Normal View History

2021-01-19 21:13:13 +08:00
---
home: true
title: Home
heroImage: /hero.png
actions:
- text: Get Started
link: /guide/getting-started.html
type: primary
- text: Introduction
link: /guide/
type: secondary
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, 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
<CodeGroup>
<CodeGroupItem title="YARN" active>
```bash
# install in your project
yarn add -D vuepress@next
# create a markdown file
echo '# Hello VuePress' > README.md
# start writing
yarn vuepress dev
# build to static files
yarn vuepress build
```
</CodeGroupItem>
<CodeGroupItem title="NPM">
```bash
# install in your project
npm install -D vuepress@next
# create a markdown file
echo '# Hello VuePress' > README.md
# start writing
npx vuepress dev
# build to static files
npx vuepress build
```
</CodeGroupItem>
</CodeGroup>