https://github.com/mikqi/vuepressify

CLI for add Vuepress to existing project
https://github.com/mikqi/vuepressify

cli generator vue vuepress

Last synced: about 1 month ago
JSON representation

CLI for add Vuepress to existing project

• Host: GitHub
• URL: https://github.com/mikqi/vuepressify
• Owner: mikqi
• License: mit
• Created: 2018-06-13T12:23:21.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-10-12T05:07:47.000Z (about 5 years ago)
• Last Synced: 2024-11-17T15:21:04.653Z (about 2 months ago)
• Topics: cli, generator, vue, vuepress
• Language: JavaScript
• Homepage:
• Size: 3.47 MB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# VuePressify [![Build Status](https://travis-ci.org/mikqi/vuepressify.svg?branch=master&longCache=true)](https://travis-ci.org/mikqi/vuepressify) ![license mit](https://img.shields.io/github/license/mikqi/vuepressify.svg?longCache=true) [![Twitter](https://img.shields.io/twitter/url/https/github.com/mikqi/vuepressify.svg)](https://twitter.com/intent/tweet?text=Add%20Vuepress%20to%20your%20existing%20project%20with%20Vuepressify%20🎉🎉%20:&url=https%3A%2F%2Fgithub.com%2Fmikqi%2Fvuepressify)[![npm version](https://badge.fury.io/js/vuepressify.svg)](https://badge.fury.io/js/vuepressify)



  



> Add Vuepress documentation to your existing project with one command

## Usage

First, you must install [NodeJS](https://nodejs.org) then you can add Vuepress to your existing project using this command:

```

$ npx vuepressify init

```

or you can install globally

```

$ npm i -g vuepressify

$ vuepressify init

```

and then it will ask you several question.

You can generate new docs with this commands too.

```

$ vuepressify --generate newDocs --loc myDocs

```

or you can simply like this

```

$ vuepressify -g newDocs --l myDocs

```

flag `generate` is required if you want to generate new docs and `loc` is `optional` by default it will set to `docs` folder

```

$ vuepressify --help

Usage

    $ vuepressify init

    or

    $ vuperessify 

  Options

    --generate=pagename,   -g    generate new page/docs

    --loc=value,        -l    set location for generate new docs. default is *docs*

    --help                    show available commands

    --version                 show vuepressify version

  Examples

    $ vuepressify --generate=new_docs

    or

    $ vuepressify --generate=new_docs --loc=documentation

```

## How to run documentation

It already added script to your `package.json`. more detail read [this](https://vuepress.vuejs.org/guide/getting-started.html#inside-an-existing-project)

Just run `npm run docs:dev` to see it in your browser.

```json

{

  "scripts": {

    "docs:dev": "vuepress dev docs",

    "docs:build": "vuepress build docs"

  }

}

```

## Built with

- [meow](https://github.com/sindresorhus/meow)

- [inquirer](https://github.com/SBoudrias/Inquirer.js)

- [chalk](https://github.com/chalk/chalk)

- [ejs](https://github.com/tj/ejs)

- [fs-extra](https://github.com/jprichardson/node-fs-extra)

## License

MIT © [Muhammad Rivki](http://this.rivki.id)