README.md

This is the branch for VuePress Next.

Status: alpha

Certain combinations of plugins may not work properly, and things may change or break until we reach beta phase. Do not use in production yet unless you are adventurous.

For 0.x, it's moved to 0.x branch and still maintained, the website was switching to https://v0.vuepress.vuejs.org.

Note that we are working hard to improve the documentation and contributions welcome if you keep up with the latest changes.

VuePress

Minimalistic docs generator with Vue component based layout system

https://vuepress.vuejs.org/

Install

yarn add vuepress -D       # Install 0.x.x.
yarn add vuepress@next -D  # Install next.

Features

Built-in markdown extensions

• Table of Contents
• Custom Containers
• Line Highlighting
• Line Numbers
• Import Code Snippets

Using Vue in Markdown

• Templating
• Using Components

Vue-powered custom theme system

• Metadata
• Content Excerpt

Default theme

• Responsive layout
• Optional Homepage
• Simple out-of-the-box header-based search
• Algolia Search
• Customizable navbar and sidebar
• Auto-generated GitHub link and page edit links
• PWA: Popup UI to refresh contents
• Last Updated

Miscellaneous

• Multi-Language Support
• Service Worker
• Google Analytics

Showcase

Check out Awesome Vuepress to find awesome things related to VuePress.

Development

Please make sure your version of Node.js is greater than 8.

yarn
yarn dev  # serves VuePress' own docs with itself
yarn test # make sure your code change pass the test

If you intend to make "substantial" changes to VuePress or its documentation, please checkout VuePress RFCs.

License

MIT