{"id":19262757,"url":"https://github.com/documentationjs/documentation-theme-utils","last_synced_at":"2025-02-23T18:43:51.627Z","repository":{"id":66153295,"uuid":"47579753","full_name":"documentationjs/documentation-theme-utils","owner":"documentationjs","description":null,"archived":false,"fork":false,"pushed_at":"2018-11-15T14:32:30.000Z","size":35,"stargazers_count":1,"open_issues_count":13,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-01-05T10:30:04.230Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/documentationjs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-12-07T21:18:08.000Z","updated_at":"2019-08-06T16:58:48.000Z","dependencies_parsed_at":"2023-07-20T11:30:54.884Z","dependency_job_id":null,"html_url":"https://github.com/documentationjs/documentation-theme-utils","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/documentationjs%2Fdocumentation-theme-utils","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/documentationjs%2Fdocumentation-theme-utils/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/documentationjs%2Fdocumentation-theme-utils/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/documentationjs%2Fdocumentation-theme-utils/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/documentationjs","download_url":"https://codeload.github.com/documentationjs/documentation-theme-utils/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240364299,"owners_count":19789756,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T19:33:22.682Z","updated_at":"2025-02-23T18:43:51.574Z","avatar_url":"https://github.com/documentationjs.png","language":"JavaScript","readme":"# documentation-theme-utils\n\n[![Greenkeeper badge](https://badges.greenkeeper.io/documentationjs/documentation-theme-utils.svg)](https://greenkeeper.io/)\n\n[![Circle CI](https://circleci.com/gh/documentationjs/documentation-theme-utils/tree/master.svg?style=svg)](https://circleci.com/gh/documentationjs/documentation-theme-utils/tree/master)\n[![Coverage Status](https://coveralls.io/repos/documentationjs/documentation-theme-utils/badge.svg?branch=master\u0026service=github)](https://coveralls.io/github/documentationjs/documentation-theme-utils?branch=master)\n\nUtilities that help in the process of building theme modules\nfor documentation.js.\n\n## API\n\n### link\n\nHelper used to automatically link items to global JS documentation or to internal\ndocumentation.\n\n**Parameters**\n\n-   `text` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** text to potentially link\n-   `getHref` **\\[[function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)]** a function that tries\n    to find a URL to point a named link to\n-   `description`  \n\n**Examples**\n\n```javascript\nlink('string').url // =\u003e 'https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String'\n```\n\nReturns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** [mdast](https://www.npmjs.com/package/mdast) node\n\n### formatType\n\nHelper used to format JSDoc-style type definitions into HTML or Markdown.\n\n**Parameters**\n\n-   `node` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** type object in doctrine style\n-   `getHref` **[function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** a function that tries\n    to find a URL to point a named link to\n\n**Examples**\n\n```javascript\nformatType({ type: 'NameExpression', name: 'String' })[0].url // =\u003e 'https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String'\n```\n\nReturns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)\u0026lt;[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)\u003e** array of [mdast](https://www.npmjs.com/package/mdast) syntax trees\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocumentationjs%2Fdocumentation-theme-utils","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocumentationjs%2Fdocumentation-theme-utils","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocumentationjs%2Fdocumentation-theme-utils/lists"}