# typedoc-plugin-cname

> CNAME file configuration for typedoc generation

Latest version **1.0.1** (published 2021-02-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install typedoc-plugin-cname
pnpm add typedoc-plugin-cname
yarn add typedoc-plugin-cname
bun add typedoc-plugin-cname
```

## 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.0.1 |
| Published | 2021-02-22 |
| First published | 2021-02-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Josh Stern |
| Maintainers | josh_stern |
| Keywords | cname, typedoc, typedocplugin, github, pages |

## Links

- npm: https://www.npmjs.com/package/typedoc-plugin-cname
- Repository: https://github.com/JoshStern/typedoc-plugin-cname
- Issues: https://github.com/JoshStern/typedoc-plugin-cname/issues
- npm.io page: https://npm.io/package/typedoc-plugin-cname

## Recent versions

- 1.0.1 (latest) — 2021-02-22
- 1.0.0 — 2021-02-22
- 0.1.4 — 2021-02-22
- 0.1.3 — 2021-02-22
- 0.1.2 — 2021-02-22
- 0.1.1 — 2021-02-22
- 0.1.0 — 2021-02-22

## README

# CNAME file configuration for typedoc
![License](https://img.shields.io/npm/l/typedoc-plugin-cname)
[![Coverage](https://img.shields.io/codecov/c/gh/JoshStern/typedoc-plugin-cname)](https://app.codecov.io/gh/JoshStern/typedoc-plugin-cname)
![Size](https://img.shields.io/bundlephobia/min/typedoc-plugin-cname)
[![Version](https://img.shields.io/npm/v/typedoc-plugin-cname)](https://www.npmjs.com/package/typedoc-plugin-cname)

Github pages uses a `CNAME` file at the root of the docs directory and `typedoc` will remove the
it when regenerating docs. `typedoc-plugin-cname` allows for a CNAME host to be configured and
added to the output directory.

## Installation
```sh
npm install -D typedoc typedoc-plugin-cname
```

## Usage
This plugin adds the `cname` option which can be used to set a hostname.

### CLI
```sh
npx tsdoc --plugin typedoc-plugin-cname --cname <host> <entryPoint>
```

### Config file
```json
// typedoc.json
{
  // ...
  "cname": "<host>"
}
```

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