Skip to content
Yeoman generator for VuePress
JavaScript Vue
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
__tests__
generators
.editorconfig
.eslintignore
.gitattributes
.gitignore
.travis.yml
.yo-rc.json
LICENSE
README.md
package-lock.json
package.json

README.md

generator-vuepress NPM version Build Status Dependency Status contributions welcome

Yeoman generator for VuePress

Installation

First, install Yeoman and generator-vuepress using npm (we assume you have pre-installed node.js).

npm install -g vuepress
npm install -g yo
npm install -g generator-vuepress

Then generate your new project:

yo vuepress

Check out for VuePress Docs here.

Getting started

npm run docs:dev

Generate Page

yo vuepress:page

Creates a [folder]/README.md under docs. Overwrite the conflicts to persist the theme configurations.

Generate Component

yo vuepress:component

Creates a component under docs/.vuepress/components.

Generate PDF

yo vuepress:pdf

Creates a pdf document from the builded project. The sections are sorted by themeConfig.nav.

Build

npm run docs:build

Build generated under docs/.vuepress/dist

File tree

.
├── docs
│   ├── about
│   │   └── README.md
│   ├── contact
│   │   └── README.md
│   ├── images
│   │   └── thumbnail-256x256.png
│   ├── README.md
│   └── .vuepress
│       ├── components
│       │   ├── Button
│       │   │   └── Counter.vue
│       │   └── Demo.vue
│       ├── config.js
|       ├── dist
│       └── public
│           └── favicon.ico
└── package.json

Getting To Know Yeoman

  • Yeoman has a heart of gold.
  • Yeoman is a person with feelings and opinions, but is very easy to work with.
  • Yeoman can be too opinionated at times but is easily convinced not to be.
  • Feel free to learn more about Yeoman.

License

MIT © amimaro

You can’t perform that action at this time.