{"id":13527981,"url":"https://github.com/braintree/jsdoc-template","last_synced_at":"2025-06-25T10:40:31.981Z","repository":{"id":8898980,"uuid":"59770336","full_name":"braintree/jsdoc-template","owner":"braintree","description":"A clean, responsive documentation template with search and navigation highlighting for JSDoc 3","archived":false,"fork":false,"pushed_at":"2023-09-06T15:17:47.000Z","size":676,"stargazers_count":175,"open_issues_count":0,"forks_count":55,"subscribers_count":17,"default_branch":"main","last_synced_at":"2025-03-17T22:59:46.340Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/braintree.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2016-05-26T17:37:00.000Z","updated_at":"2025-03-05T13:19:04.000Z","dependencies_parsed_at":"2024-01-13T22:54:43.173Z","dependency_job_id":"566bd4e3-f186-40dd-85fc-9eaac4aba4c8","html_url":"https://github.com/braintree/jsdoc-template","commit_stats":{"total_commits":74,"total_committers":14,"mean_commits":5.285714285714286,"dds":0.7432432432432432,"last_synced_commit":"22300dcd7627ed0d51ffa0cf2a559756d7580fe2"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/braintree%2Fjsdoc-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/braintree%2Fjsdoc-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/braintree%2Fjsdoc-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/braintree%2Fjsdoc-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/braintree","download_url":"https://codeload.github.com/braintree/jsdoc-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246631524,"owners_count":20808698,"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-08-01T06:02:09.171Z","updated_at":"2025-04-01T11:30:40.058Z","avatar_url":"https://github.com/braintree.png","language":"CSS","funding_links":[],"categories":["CSS"],"sub_categories":[],"readme":"# Braintree JSDoc Template\n\nA clean, responsive documentation template with search and navigation highlighting for JSDoc 3. Forked from [github.com/nijikokun/minami](https://github.com/nijikokun/minami).\n\n![Braintree JS Doc Template Screenshot](https://puu.sh/rWvW0/2831fd69d6.png)\n\n## Responsive\n\n![Braintree JS Doc Template Screenshot](https://puu.sh/rWvZ6/aee92a4787.png)\n\n## Uses\n\n- [the Taffy Database library](http://taffydb.com/)\n- [Underscore Template library](http://documentcloud.github.com/underscore/#template)\n- [Algolia DocSearch](https://community.algolia.com/docsearch/)\n\n## Usage\n\nClone repository to your designated `jsdoc` template directory, then:\n\n\n### Node.js Dependency\n\nIn your projects `package.json` file add a generate script:\n\n```json\n\"script\": {\n  \"generate-docs\": \"node_modules/.bin/jsdoc --configure .jsdoc.json --verbose\"\n}\n```\n\nIn your `.jsdoc.json` file, add a template option.\n\n```json\n\"opts\": {\n  \"template\": \"node_modules/jsdoc-template\"\n}\n```\n\n### Example JSDoc Config\n\n```json\n{\n    \"tags\": {\n        \"allowUnknownTags\": true,\n        \"dictionaries\": [\"jsdoc\"]\n    },\n    \"source\": {\n        \"include\": [\"lib\", \"package.json\", \"README.md\"],\n        \"includePattern\": \".js$\",\n        \"excludePattern\": \"(node_modules/|docs)\"\n    },\n    \"plugins\": [\n        \"plugins/markdown\"\n    ],\n    \"templates\": {\n        \"referenceTitle\": \"My SDK Name\",\n        \"disableSort\": false,\n        \"collapse\": true,\n        \"resources\": {\n            \"google\": \"https://www.google.com/\"\n        }\n    },\n    \"opts\": {\n        \"destination\": \"./docs/\",\n        \"encoding\": \"utf8\",\n        \"private\": true,\n        \"recurse\": true,\n        \"template\": \"./node_modules/jsdoc-template\"\n    }\n}\n```\n\nNote: `referenceTitle` and `disableSort` will affect the output of this theme.\n\nIf you would like to enable [Algolia DocSearch](https://community.algolia.com/docsearch/), you can pass a `search` object into the `templates` object.\n\n```json\n\"templates\": {\n    \"search\": {\n        \"apiKey\": \"your-api-key\",\n        \"indexName\": \"Your index name. Defaults to braintree.\",\n        \"hitsPerPage\": \"Number of Results to show. Defaults to 7.\",\n    }\n}\n```\n\n## License\n\nLicensed under the Apache2 license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbraintree%2Fjsdoc-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbraintree%2Fjsdoc-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbraintree%2Fjsdoc-template/lists"}