# typedoc-github-wiki-theme

> Generates TypeDoc Markdown output for GitHub Wiki.

Latest version **2.1.1** (published 2026-09-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install typedoc-github-wiki-theme
pnpm add typedoc-github-wiki-theme
yarn add typedoc-github-wiki-theme
bun add typedoc-github-wiki-theme
```

## Health

**Score 65/100 (B)** — status: active.

Positive: esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 2.1.1 |
| Published | 2026-09-07 |
| First published | 2020-10-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Node | >= 18 |
| Dependencies | 0 |
| Unpacked size | 8.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 822 |
| Author | Thomas Grey |
| Maintainers | tgreyuk |
| Keywords | typedoc, github-wiki |

## Links

- npm: https://www.npmjs.com/package/typedoc-github-wiki-theme
- Repository: https://github.com/typedoc2md/typedoc-plugin-markdown
- Homepage: https://typedoc-plugin-markdown.org/plugins/github-wiki
- Issues: https://github.com/typedoc2md/typedoc-plugin-markdown/issues
- npm.io page: https://npm.io/package/typedoc-github-wiki-theme

## Recent versions

- 2.1.1 (latest) — 2026-09-07
- 2.0.0-next.9 (next) — 2024-04-19
- 2.1.0 — 2024-11-27
- 2.0.0 — 2024-05-03
- 2.0.0-next.8 — 2024-04-06
- 2.0.0-next.7 — 2024-03-21
- 2.0.0-next.6 — 2024-02-07
- 2.0.0-next.5 — 2024-01-30
- 2.0.0-next.4 — 2024-01-18
- 2.0.0-next.3 — 2024-01-12
- 2.0.0-next.2 — 2023-05-26
- 2.0.0-next.1 — 2023-05-17
- 2.0.0-next.0 — 2023-05-13
- 1.1.0 — 2023-04-11
- 1.0.1 — 2022-05-15
- … 12 more at https://npm.io/package/typedoc-github-wiki-theme/versions

## README

# typedoc-github-wiki-theme

[![npm](https://img.shields.io/npm/v/typedoc-github-wiki-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-github-wiki-theme) [![Downloads](https://img.shields.io/npm/dw/typedoc-github-wiki-theme?label=downloads)](https://www.npmjs.com/package/typedoc-github-wiki-theme) [![Build Status](https://github.com/typedoc2md/typedoc-plugin-markdown/actions/workflows/ci.typedoc-github-wiki-theme.yml/badge.svg?branch=main&style=flat-square)](https://github.com/typedoc2md/typedoc-plugin-markdown/actions/workflows/ci.typedoc-github-wiki-theme.yml)

## Overview

**`typedoc-github-wiki-theme`** applies GitHub Wiki-specific naming and link behavior on top of `typedoc-plugin-markdown`.

Use it when you want the generated API docs to drop straight into a repository wiki without manually reworking page names, links, or sidebar navigation.

## Installation

```shell
npm install typedoc typedoc-plugin-markdown typedoc-github-wiki-theme --save-dev
```

## Features

- Generates Wiki friendly file names.
- Updates internal urls to a compatible format.
- Writes a `_Sidebar.md` file to display sidebar navigation.

## Documentation

See the [documentation](https://typedoc-plugin-markdown.org/plugins/github-wiki) for installation, configuration options, and usage guides.

## License

MIT

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