Repository files navigation

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

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

Parameters

• textString text to potentially link
• getHref[function] a function that triesto 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'

ReturnsObjectmdast node

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

Parameters

• nodeObject type object in doctrine style
• getHreffunction a function that triesto 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'

ReturnsArray<Object> array ofmdast syntax trees