Deprecate Google Analytics Integration about typedoc HOT 9 CLOSED

One can be easily constructed from the code in 1b55285

$ typedoc --plugin ./analytics.mjs

// @ts-check
// Apache License 2.0 - https://github.com/TypeStrong/typedoc/blob/master/LICENSE
import td from "typedoc";

/** @param {td.Application} app */
export function load(app) {
    app.options.addDeclaration({
        name: "gaID",
        help: "Set the Google Analytics tracking ID and activate tracking code",
        type: td.ParameterType.String,
    });

    app.renderer.hooks.on("body.end", () => {
        const gaID = app.options.getValue("gaID");
        if (gaID) {
            const script = `
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', '${gaID}');
`.trim();
            return td.JSX.createElement(td.JSX.Fragment, null, [
                td.JSX.createElement("script", {
                    async: true,
                    src: "https://www.googletagmanager.com/gtag/js?id=" + gaID,
                }),
                td.JSX.createElement("script", null, td.JSX.createElement(td.JSX.Raw, { html: script })),
            ]);
        }
        return td.JSX.createElement(td.JSX.Fragment, null);
    });
}

from typedoc.

Fixed with TypeStrong/typedoc-site@c43e28b, thanks

from typedoc.

Are you aware of any google analytics plugin? I would like to migrate

from typedoc.

I think in the official docs website, gaId is still specified as a possible option

from typedoc.

One can be easily constructed from the code in 1b55285

$ typedoc --plugin ./analytics.mjs

// @ts-check
// Apache License 2.0 - https://github.com/TypeStrong/typedoc/blob/master/LICENSE
import td from "typedoc";

/** @param {td.Application} app */
export function load(app) {
    app.options.addDeclaration({
        name: "gaID",
        help: "Set the Google Analytics tracking ID and activate tracking code",
        type: td.ParameterType.String,
    });

    app.renderer.hooks.on("body.end", () => {
        const gaID = app.options.getValue("gaID");
        if (gaID) {
            const script = `
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', '${gaID}');
`.trim();
            return td.JSX.createElement(td.JSX.Fragment, null, [
                td.JSX.createElement("script", {
                    async: true,
                    src: "https://www.googletagmanager.com/gtag/js?id=" + gaID,
                }),
                td.JSX.createElement("script", null, td.JSX.createElement(td.JSX.Raw, { html: script })),
            ]);
        }
        return td.JSX.createElement(td.JSX.Fragment, null);
    });
}

Hello, this plugin has been done today, it can be found here: https://www.npmjs.com/package/typedoc-plugin-ga

Feedback would be nice, also, can it be added to typedoc's documentation, in the plugins' list?

from typedoc.

It will automatically be picked up when the site rebuilds tonight

from typedoc.

It didn't appear

from typedoc.

Ah, that's because you don't have a peerDependency declared. Setting it to 0.26.x will make it show up.

from typedoc.

Oh ok, I had it as dev, thanks

from typedoc.