# flowee-doc

> generate html- and markdown-endpoints based on flowee (swagger) model

Latest version **1.0.3** (published 2016-06-09) · ISC license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2016-06-09 |
| First published | 2016-05-19 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+17 in 2 direct dependencies) |
| Install scripts | yes |
| GitHub stars | 0 |
| Maintainers | coderofsalvation |

## Links

- npm: https://www.npmjs.com/package/flowee-doc
- Repository: https://coderofsalvation@github.com/coderofsalvation/flowee-doc
- Homepage: https://github.com/coderofsalvation/flowee-doc#readme
- Issues: https://github.com/coderofsalvation/flowee-doc/issues
- npm.io page: https://npm.io/package/flowee-doc

## Dependencies (3)

- [ecstatic](https://npm.io/package/ecstatic.md) ^1.4.0
- [swagger-ui](https://npm.io/package/swagger-ui.md) 2.1.3
- [json-ref-lite](https://npm.io/package/json-ref-lite.md) ^1.0.73

## Recent versions

- 1.0.3 (latest) — 2016-06-09
- 1.0.2 — 2016-05-20
- 1.0.1 — 2016-05-19

## README

Helper / Example extension for automatic html+markdown api docs for flowee 

![Build Status](https://travis-ci.org/coderofsalvation/flowee-doc.svg?branch=master)

## Usage

Assuming you already have your [flowee](https://npmjs.org/flowee) api running/installed:

    npm install flowee-doc

## Usage

    require('flowee-doc')(flowee)                        <------ add this
    app = flowee.init( {model: model, store:true } )

then surf to `/doc` or `/doc/md` for html/markdown output:

<img alt="" src=".doc/apiexplorer.png"/>

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