# vueui-doc-gen

> [中文README](./README_zh.md)

Latest version **0.1.1** (published 2020-12-05) · 0 weekly downloads

## Install

```sh
npm install vueui-doc-gen
pnpm add vueui-doc-gen
yarn add vueui-doc-gen
bun add vueui-doc-gen
```

Provides the command `vueui-doc-gen`.

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2020-12-05 |
| First published | 2020-12-05 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 23 |
| Unpacked size | 62.6 KB |
| Known vulnerabilities | 0 (+9 in 4 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | yuhangdong |
| Maintainers | yuhangdong |

## Links

- npm: https://www.npmjs.com/package/vueui-doc-gen
- Repository: https://github.com/yuhang-dong/vueui-doc-gen
- Issues: https://github.com/yuhang-dong/vueui-doc-gen/issues
- npm.io page: https://npm.io/package/vueui-doc-gen

## Dependencies (23)

- [vue](https://npm.io/package/vue.md) ^2.6.11
- [less](https://npm.io/package/less.md) ^3.0.4
- [webpack](https://npm.io/package/webpack.md) >=4.0
- [css-loader](https://npm.io/package/css-loader.md) ^3.6.0
- [url-loader](https://npm.io/package/url-loader.md) ^4.1.1
- [vue-loader](https://npm.io/package/vue-loader.md) ^15.9.5
- [vue-router](https://npm.io/package/vue-router.md) ^3.2.0
- [file-loader](https://npm.io/package/file-loader.md) ^6.2.0
- [less-loader](https://npm.io/package/less-loader.md) ^5.0.0
- [markdown-it](https://npm.io/package/markdown-it.md) ^12.0.2
- [webpack-cli](https://npm.io/package/webpack-cli.md) ^4.2.0
- [highlight.js](https://npm.io/package/highlight.js.md) ^10.4.0
- [style-loader](https://npm.io/package/style-loader.md) ^2.0.0
- [normalize.css](https://npm.io/package/normalize.css.md) ^8.0.1
- [json-templater](https://npm.io/package/json-templater.md) ^1.2.0
- [vue-svg-loader](https://npm.io/package/vue-svg-loader.md) ^0.16.0
- [vue-style-loader](https://npm.io/package/vue-style-loader.md) ^4.1.2
- [markdown-it-chain](https://npm.io/package/markdown-it-chain.md) ^1.3.0
- [webpack-dev-server](https://npm.io/package/webpack-dev-server.md) ^3.11.0
- [html-webpack-plugin](https://npm.io/package/html-webpack-plugin.md) ^4.0.0-alpha.3
- [markdown-it-container](https://npm.io/package/markdown-it-container.md) ^3.0.0
- [vue-template-compiler](https://npm.io/package/vue-template-compiler.md) ^2.6.11
- [@vue/component-compiler-utils](https://npm.io/package/@vue/component-compiler-utils.md) ^3.2.0

## Recent versions

- 0.1.1 (latest) — 2020-12-05

## README

# vueui-doc-gen

[中文README](./README_zh.md)

## How to make sure you really need the project?

1. Do you have a custom UI library base on Vue2?
2. Do you want to have **ONLINE-DOCUMENT** for your UI library?
3. Do you think [the ElementUI doc](https://element.eleme.cn/#/en-US/component/installation) is very beautiful?
4. Do you want to have a same one and just need to edit markdown readme files?

OK, you need the project.

## Usage

Notice：The project has implemented a website template base on **Vue2**. It can generate your need.

A example dictionary:
```
my-ui-project
+--package               // Your UI library
|  +--carousel           // Your UI components
|  |  \---src
|  \---utils
+---config
|   |   index.js        // config file for vueui-doc-gen
|   |
|   \---docs            // Your markdown files what you want to translate to a ONLINE-DOCUMENT
|           alert.md
|           avatar.md
|           backtop.md
|           badge.md

```

### Install

NOTICE： Use **-D** / **--save-dev**

```
npm install -D vueui-doc-gen
```

### create a config file
a example config[config/index.js](./config/index.js)
```js
// my-ui-project/config/index.js

// Please use path.resolve to describe your files path
const path = require('path') 

module.exports = {
  output: path.resolve(__dirname, '../docs'), // the online-docment website's path
  usage: { // usage.importStr  tell the project how to regist your UI library
    importStr: `import ElementUI from 'element-ui'
import 'element-ui/lib/theme-chalk/index.css'
Vue.use(ElementUI)`
  },
  docs: [ // path to your readme
    {
      name: 'Aha', // first-level title， online-document has two levels
      components: [
        {
          name: 'alert', // second-level title
          location: path.resolve(__dirname, './docs/alert.md'),
          routerPath: '/alert' // unique router
        },
        {
          name: 'backtop',
          location: path.resolve(__dirname, './docs/backtop.md'),
          routerPath: '/backtop'
        }
      ]
    },
    {
      name: 'Yooo~',
      components: [
        {
          name: 'card',
          location: path.resolve(__dirname, './docs/card.md'),
          routerPath: '/card'
        },
        {
          name: 'checkbox',
          location: path.resolve(__dirname, './docs/checkbox.md'),
          routerPath: '/checkbox'
        }
      ]
    }
  ]
}

```

### generate

* preview(The usage **DOES NOT** generate output)
```shell scripts
cd my-ui-project
npx vueui-doc-gen --config ./config/index.js --mode dev
```

* generate
```shell script
cd my-ui-project
npx vueui-doc-gen --config ./config/index.js

```

## A Simple Online Example
[https://yuhang-dong.github.io/vueui-doc-gen/#/](https://yuhang-dong.github.io/vueui-doc-gen/#/)

![](./pics/result.jpg)

---
_Source: https://npm.io/package/vueui-doc-gen · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._