documentation-theme-utils

Utilities that help in the process of building theme modules for documentation.js.

API

link

Helper used to automatically link items to global JS documentation or to internal documentation.

Parameters

• textString text to potentially link
• getHref[function] a function that tries to find a URL to point a named link to
• description

Examples

link('string').url// => 'https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String'

Returns Objectmdast node

formatType

Helper used to format JSDoc-style type definitions into HTML or Markdown.

Parameters

• nodeObject type object in doctrine style
• getHreffunction a function that tries to find a URL to point a named link to

Examples

formatType({type: 'NameExpression',name: 'String'})[0].url// => 'https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String'

Returns Array<Object> array of mdast syntax trees