{"id":23380588,"url":"https://github.com/agility/agility-jsdoc-template","last_synced_at":"2025-04-08T07:43:12.780Z","repository":{"id":57174514,"uuid":"175047843","full_name":"agility/agility-jsdoc-template","owner":"agility","description":"Agility JSDoc 3 Template","archived":false,"fork":false,"pushed_at":"2019-07-16T15:35:40.000Z","size":593,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-16T19:18:52.262Z","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":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/agility.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-03-11T17:11:27.000Z","updated_at":"2019-07-16T15:35:42.000Z","dependencies_parsed_at":"2022-08-29T00:10:42.391Z","dependency_job_id":null,"html_url":"https://github.com/agility/agility-jsdoc-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agility%2Fagility-jsdoc-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agility%2Fagility-jsdoc-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agility%2Fagility-jsdoc-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agility%2Fagility-jsdoc-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/agility","download_url":"https://codeload.github.com/agility/agility-jsdoc-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247669525,"owners_count":20976396,"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-12-21T20:16:54.579Z","updated_at":"2025-04-08T07:43:12.763Z","avatar_url":"https://github.com/agility.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://agility.visualstudio.com/Agility CMS/_apis/build/status/Agility%20JsDoc%20Template?branchName=master)](https://agility.visualstudio.com/Agility CMS/_build/latest?definitionId=56\u0026branchName=master)\n\n# Agility JsDoc Template\n\nA clean, responsive documentation template theme for JSDoc 3. This has been customized for use with Agility.\n\n[Live Demo](https://agilitydocs.netlify.com/agility-content-fetch-js-sdk/)\n\n\n## Install\n\n```bash\n$ npm install --save-dev agility-jsdoc-template\n```\n\n\n## Usage\n\nClone repository to your designated `jsdoc` template directory, then:\n\n```bash\n$ jsdoc entry-file.js -t path/to/agility-jsdoc-template\n```\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/agility-jsdoc-template\"\n}\n```\n\n\n### Example JSDoc Config\n\n```json\n{\n    \"source\": {\n        \"include\": [\"src\", \"README.md\", \"package.json\"],\n        \"includePattern\": \".js$\",\n        \"excludePattern\": \"(node_modules/|docs)\"\n    },\n    \"plugins\": [\n        \"plugins/markdown\"\n    ],\n    \"recurse\": 10,\n    \"templates\": {\n        \"cleverLinks\": false,\n        \"monospaceLinks\": true,\n        \"useLongnameInNav\": true,\n        \"showInheritedInNav\": true\n    },\n    \"tags\": {\n        \"allowUnknownTags\": true,\n        \"dictionaries\": [\"jsdoc\"]\n    },\n    \"source-type\": \"module\",\n    \"opts\": {\n        \"destination\": \"./docs/\",\n        \"encoding\": \"utf8\",\n        \"private\": false,\n        \"recurse\": true,\n        \"template\": \"./node_modules/agility-jsdoc-template\"        \n    }\n}\n```\n\nSpecifying a number for useLongnameInNav it will be the max number of path elements to show in nav (starting from Class).\n\n\n## License\n\nLicensed under the Apache2 license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagility%2Fagility-jsdoc-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fagility%2Fagility-jsdoc-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagility%2Fagility-jsdoc-template/lists"}