{"id":20596088,"url":"https://github.com/davidfig/jsdoc-template","last_synced_at":"2025-09-08T12:39:00.064Z","repository":{"id":57404913,"uuid":"116692866","full_name":"davidfig/jsdoc-template","owner":"davidfig","description":"jsdoc-template for my projects based on @pixi/jsdoc-template","archived":false,"fork":false,"pushed_at":"2018-01-16T01:36:49.000Z","size":262,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-20T11:46:55.534Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/davidfig.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":"2018-01-08T15:19:33.000Z","updated_at":"2019-03-23T15:12:30.000Z","dependencies_parsed_at":"2022-09-26T17:01:39.665Z","dependency_job_id":null,"html_url":"https://github.com/davidfig/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/davidfig%2Fjsdoc-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidfig%2Fjsdoc-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidfig%2Fjsdoc-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidfig%2Fjsdoc-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/davidfig","download_url":"https://codeload.github.com/davidfig/jsdoc-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242231436,"owners_count":20093636,"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-16T08:15:06.448Z","updated_at":"2025-03-06T15:16:46.110Z","avatar_url":"https://github.com/davidfig.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PixiJS template for JSDoc 3\n\n- [PixiJS](http://pixijs.com/)\n- [JSDoc3](https://github.com/jsdoc3/jsdoc)\n- [JSDoc3 API Documentations](http://usejsdoc.org)\n\n## Installation\n\nInstall the template using NPM:\n\n```bash\nnpm install @pixi/jsdoc-template --save-dev\n```\n\n## Usage\n\nIf you already have JSDoc system, you can use this project as JSDoc template. More information about JSDoc command-line arguments can be found [here](http://usejsdoc.org/about-commandline.html).\n \n```bash\njsdoc -c conf.json -R README.md\n```\n\n### conf.json\n\nYou can set options for customizing your documentations. Notice the `\"template\"` field for setting the path to **pixi-jsdoc-template**.\n\n```json\n\"templates\": {\n    \"applicationName\": \"Demo\",\n    \"disqus\": \"\",\n    \"googleAnalytics\": \"\",\n    \"openGraph\": {\n        \"title\": \"\",\n        \"type\": \"website\",\n        \"image\": \"\",\n        \"site_name\": \"\",\n        \"url\": \"\"\n    },\n    \"meta\": {\n        \"title\": \"\",\n        \"description\": \"\",\n        \"keyword\": \"\"\n    },\n    \"linenums\": true,\n    \"source\": {\n        \"include\": [\n            \"./src/\"\n        ],\n        \"includePattern\": \".+\\\\.js(doc)?$\",\n        \"excludePattern\": \"(^|\\\\/|\\\\\\\\)_\"\n    },\n    \"opts\": {\n        \"encoding\": \"utf8\",\n        \"recurse\": true,\n        \"private\": false,\n        \"lenient\": true,\n        \"destination\": \"./docs\",\n        \"template\": \"./node_modules/@pixi/jsdoc-template\"\n    }\n}\n```\n\n## License\n\nThis project under the MIT License. and this project refered by default template for JSDoc 3.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavidfig%2Fjsdoc-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdavidfig%2Fjsdoc-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavidfig%2Fjsdoc-template/lists"}