{"_id":"@braintree/jsdoc-template","name":"@braintree/jsdoc-template","dist-tags":{"latest":"4.0.0"},"versions":{"4.0.0":{"name":"@braintree/jsdoc-template","version":"4.0.0","description":"Braintree JSDoc 3 Template","main":"publish.js","scripts":{"lint":"eslint .","test":"npm run lint","preversion":"./scripts/preversion","prepare":"husky","commit":"cz"},"repository":{"type":"git","url":"git+https://github.com/braintree/jsdoc-template.git"},"author":{"name":"Braintreeps","email":"code@getbraintree.com"},"licenses":[{"type":"Apache-2.0","url":"http://www.apache.org/licenses/LICENSE-2.0"}],"bugs":{"url":"https://github.com/braintree/jsdoc-template"},"homepage":"https://github.com/braintree/jsdoc-template","devDependencies":{"@commitlint/cli":"^20.5.0","@commitlint/config-conventional":"^20.5.0","@jsdoc/salty":"^0.2.12","commitizen":"^4.3.1","cz-customizable":"^7.5.4","eslint":"^8.13.0","eslint-config-braintree":"^5.0.1","husky":"^9.1.7"},"config":{"commitizen":{"path":"./node_modules/cz-customizable"}},"_id":"@braintree/jsdoc-template@4.0.0","gitHead":"4faf86f86a21dde78e964ead2a45055f271a5226","_nodeVersion":"18.20.8","_npmVersion":"10.8.2","dist":{"integrity":"sha512-CWKS+LH8Jptgfs1VwFFH5GKpSlofM8oG2QOd+ajGhtGqzDtLtKEENTs7FiEIoxwabdK3UfnnCKB2ucqph3tQjA==","shasum":"1a4c0c084f63ba76083422890e45a75db7812c24","tarball":"https://registry.npmjs.org/@braintree/jsdoc-template/-/jsdoc-template-4.0.0.tgz","fileCount":55,"unpackedSize":1469563,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIAbzct4l37GZu6QdW8ferLBT8+Hi7lUg9rix5uPuAyaEAiBnIa1qdeHtK0BMKx1bSapeTYpIuBVoDZxyOSushlC4Uw=="}]},"_npmUser":{"name":"braintree","email":"sdk-package-registries@paypal.com"},"directories":{},"maintainers":[{"name":"braintree","email":"sdk-package-registries@paypal.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/jsdoc-template_4.0.0_1782396867928_0.30481437835674674"},"_hasShrinkwrap":false}},"time":{"created":"2026-06-25T14:14:27.780Z","4.0.0":"2026-06-25T14:14:28.151Z","modified":"2026-06-25T14:14:28.279Z"},"maintainers":[{"name":"braintree","email":"sdk-package-registries@paypal.com"}],"description":"Braintree JSDoc 3 Template","homepage":"https://github.com/braintree/jsdoc-template","repository":{"type":"git","url":"git+https://github.com/braintree/jsdoc-template.git"},"author":{"name":"Braintreeps","email":"code@getbraintree.com"},"bugs":{"url":"https://github.com/braintree/jsdoc-template"},"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- [JSdoc salty](https://github.com/jsdoc/jsdoc/tree/main/packages/jsdoc-salty)\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### 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","readmeFilename":"README.md","_rev":"1-40872dca408c14863f04c5d9b52291eb"}