Typedoc: Include custom Handlebars helpers

Created on 23 Oct 2015 · 8Comments · Source: TypeStrong/typedoc

It would be convenient to be able to specify a js file on the command line which contains handlebars helpers. Much like is included in the typedoc/src/td/output/plugins/MarkedPlugin.ts file on lines 90-95.

            Handlebars.registerHelper('markdown', function(arg:any) { return that.parseMarkdown(arg.fn(this), this); });
            Handlebars.registerHelper('compact',  function(arg:any) { return that.getCompact(arg.fn(this)); });
            Handlebars.registerHelper('relativeURL', (url:string) => this.getRelativeUrl(url));
            Handlebars.registerHelper('wbr', (str:string) => this.getWordBreaks(str));
            Handlebars.registerHelper('ifCond', function(v1, operator, v2, options) { return that.getIfCond(v1, operator, v2, options, this) });
            Handlebars.registerHelper('ifSignature', function(obj:any, arg:any) { return obj instanceof models.SignatureReflection ? arg.fn(this) : arg.inverse(this) });

This would allow for further customization of the themes. I would be able to pass in my own helpers.

enhancement

Source

mikeloll

Most helpful comment

I figured this out.

Create a new helpers directory under your desired theme, e.g. default
Each helper can be in a single file or you can have multiple helpers

To export one or more helpers in one file you can do:

default/helpers/ifEquals.js

module.exports = {
  ifEquals: function ( value1, value2, options ) {
    return value1 === value2 ? options.fn(this) : "";
  }
}

kamranayub on 8 Jun 2016

❤2 👍1

All 8 comments

Hi Mike, nice to hear from you. We have already changed this for the next version of TypeDoc. v0.4 will automatically load all helpers stored in the /helpers/ directory of a theme.

sebastian-lenz on 25 Oct 2015

Thanks, Sebastian!

mikeloll on 26 Oct 2015

I figured this out.

Create a new helpers directory under your desired theme, e.g. default
Each helper can be in a single file or you can have multiple helpers

To export one or more helpers in one file you can do:

default/helpers/ifEquals.js

module.exports = {
  ifEquals: function ( value1, value2, options ) {
    return value1 === value2 ? options.fn(this) : "";
  }
}

kamranayub on 8 Jun 2016

❤2 👍1

Unfortunately, this nifty detail is missing in the documentation on the website http://typedoc.org/guides/themes/#custom-themes, leading to confusion in at least two plugin projects:
thepalebluedot/typedoc-md-theme and kimamula/typedoc-markdown-theme

sclausen on 23 Mar 2017

@sclausen True. If anyone wants to take a crack at updating the docs you can submit a PR to TypeStrong/typedoc-site

aciccarello on 23 Mar 2017

See #846 for an alternate way of adding helpers in a plugin.

this.application.renderer.theme.resources.deactivate();
this.application.renderer.theme.resources.helpers.addOrigin('custom-helper', `<path-to-my-custom-helper-function>`));
this.application.renderer.theme.resources.activate();

aciccarello on 8 Nov 2018

Added pointer in https://github.com/TypeStrong/typedoc-site/pull/23