Skip to content

Latest commit

 

History

History
49 lines (31 loc) · 2.27 KB

README.md

File metadata and controls

49 lines (31 loc) · 2.27 KB
Raw

documentation-theme-utils

Greenkeeper badge

Circle CI Coverage Status

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

  • text String 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 Object mdast node

formatType

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

Parameters

  • node Object type object in doctrine style
  • getHref function 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