# vuePress

**Repository Path**: wpz_com/vuePress

## Basic Information

- **Project Name**: vuePress
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: CC-BY-4.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-09-05
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
  <a href="https://vuepress.vuejs.org/" target="_blank">
    <img width="280" src="https://github.com/vuejs/vuepress/blob/master/docs/.vuepress/public/hero.png" alt="logo">
  </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
- Google Analytics Integration
- A default theme with:
  - Responsive layout
  - Optional Homepage
  - Automatic basic typeahead search
  - Customizable navbar and sidebar
  - Auto-generated GitHub link and page 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:

- Multi-Language Support
- Algolia DocSearch Integration
- 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