# generate-docs

> function to generate a documentation file from source files.

Latest version **1.1.1** (published 2018-03-18) · ISC license · 0 weekly downloads

## Install

```sh
npm install generate-docs
pnpm add generate-docs
yarn add generate-docs
bun add generate-docs
```

## 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.1.1 |
| Published | 2018-03-18 |
| First published | 2017-04-14 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 3.8 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Andrew J. Monks |
| Maintainers | amonks |

## Links

- npm: https://www.npmjs.com/package/generate-docs
- Repository: https://github.com/amonks/generate-docs
- Issues: https://github.com/amonks/generate-docs/issues
- npm.io page: https://npm.io/package/generate-docs

## Dependencies (5)

- [ramda](https://npm.io/package/ramda.md) ^0.23.0
- [globby](https://npm.io/package/globby.md) ^8.0.1
- [shelljs](https://npm.io/package/shelljs.md) ^0.7.7
- [markdown-toc](https://npm.io/package/markdown-toc.md) ^1.1.0
- [babel-runtime](https://npm.io/package/babel-runtime.md) ^6.22.0

## Recent versions

- 1.1.1 (latest) — 2018-03-18
- 1.1.0 — 2018-03-18
- 1.0.1 — 2017-04-23
- 1.0.0 — 2017-04-14

## README

# generate-docs

function to generate a documentation file from source files.

any jsdoc-style comment (starts with `/**`) is extracted and concatenated into the output file.

example:

```javascript
// docs.js

const generateDocs = require("generate-docs").default;

generateDocs({
  paths: ["readme.src.md", "*.js"],
  output: "README.md"
});
```

```markdown
<!-- readme.src.md -->

# My Cool Project

## API

<!-- TOC -->
```

```javascript
// index.js

/**
 * ## add
 * add(1, 2) // => 3
 */

const add = (a, b) => a + b;
```

```markdown
<!-- README.md -->

# My Cool Project

## API

<!-- toc -->

* [add](#add)

<!-- tocstop -->

## add

add(1, 2) // => 3
```

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