# apidoc-core

> Core parser library to generate apidoc result following the apidoc-spec

Latest version **0.15.0** (published 2021-03-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install apidoc-core
pnpm add apidoc-core
yarn add apidoc-core
bun add apidoc-core
```

## Health

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

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

Negative: critical vulnerabilities; abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.15.0 |
| Published | 2021-03-17 |
| First published | 2014-12-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.10.0 |
| Dependencies | 6 |
| Unpacked size | 115.7 KB |
| Known vulnerabilities | 2 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 69 |
| Author | Peter Rottmann |
| Maintainers | apidoc |
| Keywords | api, apidoc, doc, documentation, rest, restful |

## Links

- npm: https://www.npmjs.com/package/apidoc-core
- Repository: https://github.com/apidoc/apidoc-core
- Issues: https://github.com/apidoc/apidoc-core/issues
- npm.io page: https://npm.io/package/apidoc-core

## Dependencies (6)

- [glob](https://npm.io/package/glob.md) ^7.1.6
- [lodash](https://npm.io/package/lodash.md) ^4.17.20
- [semver](https://npm.io/package/semver.md) ~7.3.2
- [fs-extra](https://npm.io/package/fs-extra.md) ^9.0.1
- [klaw-sync](https://npm.io/package/klaw-sync.md) ^6.0.0
- [iconv-lite](https://npm.io/package/iconv-lite.md) ^0.6.2

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 0.15.0 (latest) — 2021-03-17
- 0.12.0 — 2020-08-14
- 0.11.1 — 2020-02-04
- 0.11.0 — 2019-12-02
- 0.10.0 — 2019-11-13
- 0.8.3 — 2017-05-19
- 0.8.2 — 2017-01-26
- 0.8.1 — 2017-01-23
- 0.8.0 — 2017-01-13
- 0.7.1 — 2016-04-22
- 0.7.0 — 2016-04-21
- 0.6.1 — 2016-02-17
- 0.6.0 — 2016-02-12
- 0.5.1 — 2015-12-18
- 0.5.0 — 2015-12-15
- … 10 more at https://npm.io/package/apidoc-core/versions

## README

# apidoc-core

Core parser library to generate apidoc result following the [apidoc-spec](https://github.com/apidoc/apidoc-spec).

![Build Status](https://github.com/apidoc/apidoc-core/workflows/validate/badge.svg)
[![Dependency Status](https://david-dm.org/apidoc/apidoc-core.svg)](https://david-dm.org/apidoc/apidoc-core)
[![NPM version](https://badge.fury.io/js/apidoc-core.svg)](http://badge.fury.io/js/apidoc-core)

If you are an end user, please proceed to [apidoc](https://github.com/apidoc/apidoc) or [apidoc-documentation](http://apidocjs.com).

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