Minimalistic docs generator with Vue component based layout system
- Built-in markdown extensions optimized for technical documentation
- Ability to leverage Vue inside markdown files
- Vue-powered custom theme system
- 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
VuePress is still a work in progress. There are a few things that it currently does not support but are planned:
- Dropdown Items in Navbar
- Multi-Language Support
- Algolia DocSearch Integration
- Blogging support
Contributions are welcome!
Please make sure your version of Node.js is greater than 8.
yarn
yarn dev # serves VuePress' own docs with itselfMIT