vuepress

home/vuepress

Fork 0

mirror of https://github.com/wahyd4/vuepress.git synced 2026-08-15 08:15:54 +10:00

Files

T

History

Ben Hongandfgiraud 907d8eed81 docs: Remove next recommendation (#1862 )

The `next` flag seems like an artifact for those who are not on the latest VuePress. Since we are on VuePress 1.0, this should not be the default install path

2019-09-16 19:46:58 -04:00

.vuepress

fix($theme-default): Make navbar dropdown links accessible (#1837 )

2019-09-15 16:46:58 +02:00

api

docs: documentation linting (#1745 )

2019-08-07 23:24:58 +08:00

config

docs: documentation linting (#1745 )

2019-08-07 23:24:58 +08:00

faq

docs: documentation linting (#1745 )

2019-08-07 23:24:58 +08:00

guide

fix($theme-default): Make navbar dropdown links accessible (#1837 )

2019-09-15 16:46:58 +02:00

miscellaneous

feat: Improve CI process (#1759 )

2019-09-07 14:07:16 +02:00

plugin

docs: Remove next recommendation (#1862 )

2019-09-16 19:46:58 -04:00

theme

fix($theme-default): Make navbar dropdown links accessible (#1837 )

2019-09-15 16:46:58 +02:00

fix($theme-default): Make navbar dropdown links accessible (#1837 )

2019-09-15 16:46:58 +02:00

README.md

docs: remove tag 'next' from installation instructions (#1686 )

2019-07-16 00:24:28 +08:00

README.md

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

# 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.6. :::