# @disqada/typedoc

> Generate types and docs with a click

Latest version **1.4.0** (published 2024-02-03) · Apache-2.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @disqada/typedoc
pnpm add @disqada/typedoc
yarn add @disqada/typedoc
bun add @disqada/typedoc
```

Provides the commands `clean`, `config`.

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.4.0 |
| Published | 2024-02-03 |
| First published | 2023-11-11 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | ESM |
| Node | >=13.2.0 |
| Dependencies | 0 |
| Unpacked size | 31.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 0 |
| Author | The Alpha |
| Maintainers | nabil_alsaiad |
| Keywords | types, typings, jsdoc, tsdoc, typedoc, docs, documentation, generated |

## Links

- npm: https://www.npmjs.com/package/@disqada/typedoc
- Repository: https://github.com/DisQada/TypeDoc
- Homepage: https://disqada.github.io/TypeDoc
- Issues: https://github.com/DisQada/TypeDoc/issues
- npm.io page: https://npm.io/package/@disqada/typedoc

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.4.0 (latest) — 2024-02-03
- 1.3.2 — 2024-01-02
- 1.3.1 — 2024-01-02
- 1.3.0 — 2024-01-02
- 1.2.1 — 2023-12-29
- 1.2.0 — 2023-12-27
- 1.1.0 — 2023-11-29
- 1.0.3 — 2023-11-22
- 1.0.2 — 2023-11-22
- 1.0.1 — 2023-11-11
- 1.0.0 — 2023-11-11

## README

# TypeDoc

## Badges

[![github](https://img.shields.io/badge/DisQada/TypeDoc-000000?logo=github&logoColor=white)](https://www.github.com/DisQada/TypeDoc)
[![npm](https://img.shields.io/badge/@disqada/typedoc-CB3837?logo=npm&logoColor=white)](https://www.npmjs.com/package/@disqada/typedoc)

![version](https://img.shields.io/npm/v/@disqada/typedoc.svg?label=latest&logo=npm)
![monthly downloads](https://img.shields.io/npm/dm/@disqada/typedoc.svg?logo=npm)

[![Test](https://github.com/DisQada/TypeDoc/actions/workflows/test.yml/badge.svg)](https://github.com/DisQada/TypeDoc/actions/workflows/test.yml)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

## Table of Contents

- [TypeDoc](#typedoc)
  - [Badges](#badges)
  - [Table of Contents](#table-of-contents)
  - [About](#about)
  - [License](#license)
- [Getting started](#getting-started)
  - [Configurations](#configurations)
  - [Usage](#usage)
    - [npm scripts](#npm-scripts)

## About

This tool is used to generate both declarations and documentations with couple of clicks.

## License

Copyright © 2022 [DisQada](https://github.com/DisQada)

This framework is licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).  
See the [LICENSE](LICENSE.txt) file for more information.

# Getting started

## Configurations

Add the file `docconfig.json` to your project, below a table of all possible configurations that can be used.

| Property | Type   | Default value | Description                            |
| -------- | ------ | ------------- | -------------------------------------- |
| root     | string | src           | Source code folder                     |
| types    | string | types         | Generate declarations into this folder |
| out      | string | docs          | Generate documentation this folder     |
| npm      | string | name          | Project name in npm                    |
| github   | string | Name          | Project name in GitHub                 |

## Usage

### npm scripts

The tool is used via npm scripts that are already defined in it's package.json file, and can be called from your project npm scripts directly.

Below are the available npm scripts:

- `setup`: Install the required packages as dev dependencies
- `config`: Read and cache the configuration file
- `types`: Generate declarations using cached configurations then `clean`
- `clean`: Clean the declaration files
- `doc/docs`: Generate documentations using cached configurations

First thing to do is to run the following command to install all the necessary dependencies

```bash
npm explore @disqada/typedoc -- npm run setup
```

You'll most likely have the following scripts, use the `setup` script on initialisation and every time you update the configuration file, then use the `types` and `doc/docs` scripts for generating declarations and documentation

```json
"scripts": {
    "config": "npm explore @disqada/typedoc -- npm run config",
    "types": "npm explore @disqada/typedoc -- npm run types",
    "docs": "npm explore @disqada/typedoc -- npm run docs"
}
```

If you're constantly changing the configurations, you can make one script that reads the configurations and generates the declarations/documentation like the following example:

```json
"scripts": {
    "types": "npm explore @disqada/typedoc -- npm run config && npm explore @disqada/typedoc -- npm run types",
    "docs": "npm explore @disqada/typedoc -- npm run config && npm explore @disqada/typedoc -- npm run docs"
}
```

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