# @amilajack/typedoc-plugin-markdown

> A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.

Latest version **3.0.12-alpha1** (published 2021-01-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @amilajack/typedoc-plugin-markdown
pnpm add @amilajack/typedoc-plugin-markdown
yarn add @amilajack/typedoc-plugin-markdown
bun add @amilajack/typedoc-plugin-markdown
```

## Health

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

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.0.12-alpha1 |
| Published | 2021-01-22 |
| First published | 2021-01-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10.0.0 |
| Dependencies | 1 |
| Unpacked size | 68.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 822 |
| Author | Thomas Grey |
| Maintainers | amilajack |
| Keywords | markdown, typescript, documentation, api, typedocplugin, typedoc |

## Links

- npm: https://www.npmjs.com/package/@amilajack/typedoc-plugin-markdown
- Repository: https://github.com/tgreyuk/typedoc-plugin-markdown
- Homepage: https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/typedoc-plugin-markdown
- Issues: https://github.com/tgreyuk/typedoc-plugin-markdown/issues
- npm.io page: https://npm.io/package/@amilajack/typedoc-plugin-markdown

## Dependencies (1)

- [handlebars](https://npm.io/package/handlebars.md) ^4.7.6

## 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

- 3.0.12-alpha1 (latest) — 2021-01-22
- 3.0.12-alpha — 2021-01-15
- 3.0.11-alpha — 2021-01-15
- 3.0.12 — 2021-01-15

## README

# typedoc-plugin-markdown

A plugin for [TypeDoc](https://github.com/TypeStrong/typedoc) that enables TypeScript API documentation to be generated in Markdown.

[![npm](https://img.shields.io/npm/v/typedoc-plugin-markdown.svg)](https://www.npmjs.com/package/typedoc-plugin-markdown)
[![Build Status](https://travis-ci.org/tgreyuk/typedoc-plugin-markdown.svg?branch=master)](https://travis-ci.org/tgreyuk/typedoc-plugin-markdown)

## What it does?

The plugin will replaces the default HTML theme with a built-in Markdown theme.

## Installation

```bash
npm install --save-dev typedoc typedoc-plugin-markdown
```

## Usage

```bash
$ npx typedoc --plugin typedoc-plugin-markdown [args]
```

### Note:

- The `--plugin` arg is optional - if omitted all installed plugins will run.
- If using with the default HTML theme or other themes, use `--plugin none` to switch the plugin off.
- The plugin needs to be executed from the same location as `typedoc`. Either run as an npm script or make sure to run `npx typedoc`.

## Arguments

The following arguments can be used in addition to the default [TypeDoc arguments](https://github.com/TypeStrong/typedoc#arguments).

- `--hideProjectName<boolean>`<br>
  Do not render project name in template header. Defaults to `false`.
- `--hideBreadcrumbs<boolean>`<br>
  Do not render breadcrumbs in template header. Defaults to `false`.
- `--publicPath<string>`<br>
  Specify the base path for all urls. If undefined urls will be relative. Defaults to `undefined`.
- `--namedAnchors<boolean>`<br>
  Use HTML named anchors tags for implementations that do not assign header ids. Defaults to `false`.

## Additional plugins

If using specifically for [Docusaurus v2](https://v2.docusaurus.io/) or [VuePress](https://vuepress.vuejs.org/) check out the respective plugin for the platform:

- [docusaurus-plugin-typedoc](https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/docusaurus-plugin-typedoc/README.md)
- [vuepress-plugin-typedoc](https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/vuepress-plugin-typedoc/README.md)

## License

[MIT](https://github.com/tgreyuk/typedoc-plugin-markdown/blob/master/LICENSE)

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