# carbonldp-ts-docs-engine

> Engine to generate API documentation for Carbon LDP TypeScript projects

Latest version **1.1.0** (published 2019-12-13) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install carbonldp-ts-docs-engine
pnpm add carbonldp-ts-docs-engine
yarn add carbonldp-ts-docs-engine
bun add carbonldp-ts-docs-engine
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2019-12-13 |
| First published | 2019-11-04 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 21 |
| Unpacked size | 5.6 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Rodolfo Aguirre |
| Maintainers | carbondeployer |

## Links

- npm: https://www.npmjs.com/package/carbonldp-ts-docs-engine
- Repository: https://github.com/CarbonLDP/carbonldp-ts-docs-engine
- Issues: https://github.com/CarbonLDP/carbonldp-ts-docs-engine/issues
- npm.io page: https://npm.io/package/carbonldp-ts-docs-engine

## Dependencies (21)

- [dgeni](https://npm.io/package/dgeni.md) ^0.4.12
- [tslib](https://npm.io/package/tslib.md) ^1.9.3
- [jquery](https://npm.io/package/jquery.md) ^3.4.1
- [prismjs](https://npm.io/package/prismjs.md) ^1.17.1
- [webpack](https://npm.io/package/webpack.md) ^4.39.3
- [winston](https://npm.io/package/winston.md) ^3.2.1
- [node-sass](https://npm.io/package/node-sass.md) ^4.7.2
- [css-loader](https://npm.io/package/css-loader.md) ^1.0.0
- [url-loader](https://npm.io/package/url-loader.md) ^1.1.1
- [file-loader](https://npm.io/package/file-loader.md) ^1.1.11
- [sass-loader](https://npm.io/package/sass-loader.md) ^7.1.0
- [autoprefixer](https://npm.io/package/autoprefixer.md) ^9.6.1
- [webpack-merge](https://npm.io/package/webpack-merge.md) ^4.2.2
- [dgeni-packages](https://npm.io/package/dgeni-packages.md) ^0.28.1
- [postcss-loader](https://npm.io/package/postcss-loader.md) ^3.0.0
- [html-webpack-plugin](https://npm.io/package/html-webpack-plugin.md) ^4.0.0-beta.8
- [image-webpack-loader](https://npm.io/package/image-webpack-loader.md) ^4.3.1
- [favicons-webpack-plugin](https://npm.io/package/favicons-webpack-plugin.md) ^1.0.2
- [mini-css-extract-plugin](https://npm.io/package/mini-css-extract-plugin.md) ^0.8.0
- [uglifyjs-webpack-plugin](https://npm.io/package/uglifyjs-webpack-plugin.md) ^2.2.0
- [optimize-css-assets-webpack-plugin](https://npm.io/package/optimize-css-assets-webpack-plugin.md) ^5.0.3

## Recent versions

- 1.1.0 (latest) — 2019-12-13
- 1.0.1 — 2019-11-26
- 1.0.0 — 2019-11-04

## README

# Carbon LDP TS Docs Engine

[![npm version][npm-image]][npm-url]
[![CircleCI][circle-ci-image]][circle-ci-url]


Official Typescript Docs Engine for Carbon LDP Projects. Automatically generates documentation from source code's comments.

## Installation

	npm install carbonldp-ts-docs-engine

## Usage

```typescript
import DocsEngine from "carbonldp-ts-docs-engine";

const options:DocsEngine.Options = {
	src: "src/",                                // Directory from where the documentation is generated
	out: "docs/",                               // Directory where the documentation is stored
	mode: "development",                        // Optional, mode in which the documentation is built
	logLevel: "info",                           // Optional, filter logs by different levels 
	descriptionTemplate: "path/to/template",    // Optional, must be a nunjucks file
	npmName: "carbonldp-ts-docs-engine",        // Optional, name of the npm package
	name: "CarbonLDP TS Docs Engine",           // Optional, name of the project
	mainClass: "DocsEngine",                    // Optional, name of the main class of the project
};

DocsEngine.generate(options)
	.then( () => {
		console.log("Docs generated");	
	} )
	.catch( (error) => {
		console.log("Error generating documentation");
	} )
```

---

## License

	Copyright (c) 2015-present, Base22 Technology Group, LLC
	All rights reserved.

	This source code is licensed under the BSD-style license found in the
	LICENSE file in the root directory of this source tree.
    
[npm-image]: https://img.shields.io/npm/v/carbonldp-ts-docs-engine?style=flat-square
[npm-url]: https://www.npmjs.com/package/carbonldp-ts-docs-engine
[circle-ci-image]: https://circleci.com/gh/CarbonLDP/carbonldp-ts-docs-engine.svg?style=svg
[circle-ci-url]: https://circleci.com/gh/CarbonLDP/carbonldp-ts-docs-engine

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