# ismart-doc

> API documentation generator,base in https://github.com/mhbseal/modoc

Latest version **0.1.2** (published 2018-03-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install ismart-doc
pnpm add ismart-doc
yarn add ismart-doc
bun add ismart-doc
```

Provides the command `smartdoc`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2018-03-17 |
| First published | 2018-03-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 134.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | sbness |
| Keywords | documentation, generator, API |

## Links

- npm: https://www.npmjs.com/package/ismart-doc
- Repository: https://github.com/hnzxb/ismart-doc
- Issues: https://github.com/hnzxb/ismart-doc/issues
- npm.io page: https://npm.io/package/ismart-doc

## Dependencies (1)

- [underscore](https://npm.io/package/underscore.md) ^1.8.3

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 0.1.2 (latest) — 2018-03-17
- 0.1.1 — 2018-03-17
- 0.1.0 — 2018-03-17

## README

# ismart-doc
### An API documentation generator base of [modoc](https://github.com/mhbseal/modoc)

#### Install and Run

npm

    npm install ismart-doc -g
    
    smartdoc --config <configPath>

github
    
    git clone https://github.com/hnzxb/ismart-doc
    cd ismart-doc && npm install
    
    node index.js --config <configPath>

#### Example
source contains mojs example,so wen can Enter 'exmpale' directory after install(npm or github)

npm

    ismart-doc

github

    node ../index

#### Config
    /ismart.config.js
    module.exports = {
        doc: {
            name         : "ismart-path",
            title        : "Path扩展-ismart",
            version      : "0.1.0",
            repositoryUrl: "https://github.com/hnzxb/ismart-path",
            introduction : '描述',
            paths        : {
                input : "./src",
                output: "./readme"
            },
            source       : '',
            skip         : []
        }
    }
    
#### Comment Example
  
general document comment

    /**
     * description
     *
     * @param {string} 1
     * @param {object} 2
     *   - a {number} 3
     *   - b {string} 4
     * @param {function} 5
     *   - param {number} 6
     *   - param {function} 7
     *     - param 8
     * @return {object} 9
     *   - c {string} 10
     *   - d {number} 11
     */

after add generator
    
    /**
     * description
     *
     * @param {string} 1
     * @param {object} 2
     *   - a {number} 3
     *   - b {string} 4
     * @param {function} 5
     *   - param {number} 6
     *   - param {function} 7
     *     - param 8
     * @return {object} 9
     *   - c {string} 10
     *   - d {number} 11
     * 
     * @name file name or method name or property name(required)
     * @example
     * var str = 'doc';
     * num.toUpperCase();
     * ...
     * @more
     * this is more information,
     * let go.
     * ...
     */

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