<p align="center">
  <a href="https://vuepress.vuejs.org/" target="_blank">
    <img width="280" src="https://raw.githubusercontent.com/vuejs/vuepress/master/docs/.vuepress/public/hero.png" alt="logo">
  </a>
</p>

<p align="center">
  <a href="https://npmcharts.com/compare/vuepress?minimal=true"><img src="https://img.shields.io/npm/dm/vuepress.svg" alt="Downloads"></a>
  <a href="https://www.npmjs.com/package/vuepress"><img src="https://img.shields.io/npm/v/vuepress.svg" alt="Version"></a>
  <a href="https://www.npmjs.com/package/vuepress"><img src="https://img.shields.io/npm/l/vuepress.svg" alt="License"></a>
</p>

# VuePress

> Minimalistic docs generator with Vue component based layout system

https://vuepress.vuejs.org/

## Features

- [Built-in markdown extensions](https://vuepress.vuejs.org/guide/markdown.html) optimized for technical documentation
- [Ability to leverage Vue inside markdown files](https://vuepress.vuejs.org/guide/using-vue.html)
- [Vue-powered custom theme system](https://vuepress.vuejs.org/guide/custom-themes.html)
- [Service Worker Integration](https://vuepress.vuejs.org/config/#serviceworker)
- [Google Analytics Integration](https://vuepress.vuejs.org/config/#ga)
- [Multi-Language Support](https://vuepress.vuejs.org/guide/i18n.html)
- A default theme with:
  - Responsive layout
  - [Optional Homepage](https://vuepress.vuejs.org/default-theme-config/#homepage)
  - [Simple out-of-the-box header-based search](https://vuepress.vuejs.org/default-theme-config/#built-in-search)
  - [Algolia Search](https://vuepress.vuejs.org/default-theme-config/#algolia-search)
  - Customizable navbar and sidebar
  - [Auto-generated GitHub link and page edit links](https://vuepress.vuejs.org/default-theme-config/#git-repo-and-edit-links)

## Todo Features

VuePress is still a work in progress. There are a few things that it currently does not support but are planned:

- Blogging support

Contributions are welcome!

## Development

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

``` bash
yarn
yarn dev # serves VuePress' own docs with itself
```

## License

[MIT](https://github.com/vuejs/vuepress/blob/master/LICENSE)
