https://github.com/euberdeveloper/typedoc-plugin-ga

A plugin for Typedoc to add Google Analytics
https://github.com/euberdeveloper/typedoc-plugin-ga

npm typedoc typedoc-plugin typescript

Last synced: about 2 months ago
JSON representation

A plugin for Typedoc to add Google Analytics

• Host: GitHub
• URL: https://github.com/euberdeveloper/typedoc-plugin-ga
• Owner: euberdeveloper
• License: mit
• Created: 2024-08-15T17:17:53.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-12-30T13:16:25.000Z (6 months ago)
• Last Synced: 2025-04-28T12:58:38.405Z (about 2 months ago)
• Topics: npm, typedoc, typedoc-plugin, typescript
• Language: JavaScript
• Homepage:
• Size: 317 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
![Lint](https://github.com/euberdeveloper/typedoc-plugin-ga/workflows/Lint/badge.svg)

![Build](https://github.com/euberdeveloper/typedoc-plugin-ga/workflows/Build/badge.svg)

![Test](https://github.com/euberdeveloper/typedoc-plugin-ga/workflows/Test/badge.svg)

[![License](https://img.shields.io/npm/l/typedoc-plugin-ga.svg)](https://github.com/euberdeveloper/typedoc-plugin-ga/blob/main/LICENSE)

[![GitHub issues](https://img.shields.io/github/issues/euberdeveloper/typedoc-plugin-ga.svg)](https://github.com/euberdeveloper/typedoc-plugin-ga/issues)

![npm](https://img.shields.io/npm/v/typedoc-plugin-ga.svg)

# typedoc-plugin-ga

Add Google Analytics tag to your TypeDoc generated documentation. 

This plugin is needed after version [v0.26.0](https://github.com/TypeStrong/typedoc/releases/tag/v0.26.0), because the previously available `--gaID` option had been removed. It refers to [this issue](https://github.com/TypeStrong/typedoc/issues/2600#issuecomment-2184995074).

| Option                  | Default | Description                                                                                |

| ----------------------- | ------- | ------------------------------------------------------------------------------------------ |

| gaID     | `undefined`  | The `gaID` of your Google Analytics |

## Changelog

See full changelog [here](https://github.com/euberdeveloper/typedoc-plugin-ga/blob/main/CHANGELOG.md).