{"id":15065365,"url":"https://github.com/alexispuga/jsdoc-template","last_synced_at":"2025-04-10T13:32:26.912Z","repository":{"id":35094096,"uuid":"203102599","full_name":"AlexisPuga/jsdoc-template","owner":"AlexisPuga","description":"A decent template for JSDoc. See the demo here:","archived":false,"fork":false,"pushed_at":"2023-03-18T11:28:05.000Z","size":2117,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-17T19:54:55.709Z","etag":null,"topics":["eslintrc","gh-pages-site","jsdoc","jsdoc-template","npm-package","travis-ci","webpack"],"latest_commit_sha":null,"homepage":"https://alexispuga.github.io/jsdoc-template","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AlexisPuga.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2019-08-19T05:13:41.000Z","updated_at":"2022-01-16T07:36:15.000Z","dependencies_parsed_at":"2025-02-17T07:42:43.325Z","dependency_job_id":null,"html_url":"https://github.com/AlexisPuga/jsdoc-template","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexisPuga%2Fjsdoc-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexisPuga%2Fjsdoc-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexisPuga%2Fjsdoc-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexisPuga%2Fjsdoc-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AlexisPuga","download_url":"https://codeload.github.com/AlexisPuga/jsdoc-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248225710,"owners_count":21068078,"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":["eslintrc","gh-pages-site","jsdoc","jsdoc-template","npm-package","travis-ci","webpack"],"created_at":"2024-09-25T00:37:24.247Z","updated_at":"2025-04-10T13:32:26.894Z","avatar_url":"https://github.com/AlexisPuga.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# JSDoc Template ![CI](https://github.com/AlexisPuga/jsdoc-template/actions/workflows/ci.yml/badge.svg)\n\nA decent template for JSDoc, redesigned from [the default template](https://github.com/jsdoc/jsdoc/tree/master/packages/jsdoc/templates/default).\n\n[Check out the demo](https://alexispuga.github.io/jsdoc-template).\n\n## Use it\n\n### Installing it via npm\n[![NPM](https://nodei.co/npm/@alexispuga/jsdoc-template.png?compact=true)](https://npmjs.org/package/@alexispuga/jsdoc-template)\n\n```bash\nnpm i @alexispuga/jsdoc-template\njsdoc your/files -t ./node_modules/@alexispuga/jsdoc-template\n```\n\n## Previews\n\n\u003ca href=\"previews/pc.png\"\u003e\u003cimg alt=\"Large device preview\" src=\"previews/pc.png\"/\u003e\u003c/a\u003e\n\u003ca href=\"previews/tablet.png\"\u003e\u003cimg alt=\"Medium device preview\" src=\"previews/tablet.png\" height=\"660\"/\u003e\u003c/a\u003e\n\u003ca href=\"previews/phone.png\"\u003e\u003cimg alt=\"Small device preview\" src=\"previews/phone.png\" height=\"660\"/\u003e\u003c/a\u003e\n\n## Customize it\n\nMake this template yours too:\n- Create a ``` jsdoc.config.js ``` file.\n- Modify it ([see all supported properties](config.js)).\n- Load it from jsdoc: ``` jsdoc your/files -t this/template -c your/jsdoc.config.js ```.\n\n### Examples\n\n#### Changing the default font (the simplest way)\n```js\n// jsdoc.config.js\n\nmodule.exports = {\n    templates: {\n        // Options for this template.\n        custom: {\n            tags: {\n                head: [\n                    `\u003cstyle\u003ebody, html { font-family: serif; }\u003c/style\u003e`\n                ]\n            }\n        }\n    }\n}\n\n```\n\n#### Changing the theme for the prettified code and replacing it with my own (this time by using a JSON)\n\n```json\n\n{\n    \"templates\": {\n        \"default\": {\n            \"staticFiles\": {\n                \"include\": [\n                    \"./path/to/your/theme.css\"\n                ]\n            }\n        },\n        \"custom\": {\n            \"themes\": {\n                \"prettify\": \"theme.css\"\n            }\n        }\n    }\n}\n\n```\n\n#### Changing the site name and adding a favicon\n\n```javascript\n// jsdoc.config.js\n\nmodule.exports = {\n    templates: {\n        default: {\n            staticFiles: {\n                include: [\n                    'path/to/your/favicon-32x32.png'\n                ]\n            }\n        },\n        custom: {\n            siteName: 'My site',\n            tags: {\n                head: [\n                    `\u003clink href=\"favicon-32x32.png\" rel=\"icon\" sizes=\"32x32\" type=\"image/png\"/\u003e`\n                ]\n            }\n        }\n    } \n};\n\n```\n\n## Contribute\n\nYour contributions are welcome (and needed). Please check the [CONTRIBUTING](CONTRIBUTING.md) file for details.\n\n## Versioning\n\nThis project uses [SemVer](http://semver.org/) for versioning. See the available versions [here](https://github.com/AlexisPuga/jsdoc-template/tags).\n\n## License\n\nAny modification made to the [default template](https://github.com/jsdoc/jsdoc/templates/default) is licensed under the Apache License, Version 2.0 - See the [LICENSE](LICENSE) file for details.\n\nFor more information, check [the main project](https://github.com/jsdoc/jsdoc).\n\n## Acknowledgments\n\nThanks to [all people who contributed to this project](https://github.com/AlexisPuga/jsdoc-template/graphs/contributors), and [people who participated in the original one](https://github.com/jsdoc/jsdoc/graphs/contributors).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexispuga%2Fjsdoc-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falexispuga%2Fjsdoc-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexispuga%2Fjsdoc-template/lists"}