typedoc-github-theme/README.md

Elegant and seamless look and feel for your TypeScript documentation on GitHub Pages

# Theme your TypeDoc like GitHub

[![NPM](https://nodei.co/npm/typedoc-github-theme.png)](https://npmjs.org/package/typedoc-github-theme)

This [TypeDoc](https://github.com/TypeStrong/typedoc) theme is designed to provide an elegant and seamless look and feel for your TypeScript documentation on GitHub Pages, inspired by the GitHub design.

## Example

[![Example](./example.png)](https://julianwowra.github.io/typedoc-github-theme/)

## Usage

**Install the package with your favourite package manager:**

```text
npm install typedoc-github-theme --save-dev
```

```text
pnpm add typedoc-github-theme --save-dev
```

```text
yarn add typedoc-github-theme --dev
```

**Use the theme when generating your documentation:**

```text
npx typedoc src --plugin typedoc-github-theme
```

> [!NOTE]
> This plugin fills the following options if they have not been defined by the user:
> [`theme`](https://typedoc.org/options/output/#theme), [`lightHighlightTheme`](https://typedoc.org/options/output/#lighthighlighttheme), [`darkHighlightTheme`](https://typedoc.org/options/output/#darkhighlighttheme)

---

## Author

👤 **Julian Wowra <development@julianwowra.de>**

- Github: [@JulianWowra](https://github.com/JulianWowra)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!<br />Feel free to check the [issues page](https://github.com/JulianWowra/typedoc-github-theme/issues). You can also take a look at the [contributing guide](https://github.com/JulianWowra/typedoc-github-theme/blob/main/CONTRIBUTING.md).