{"_id":"@athombv/jsdoc-template","_rev":"3-255baba0c1e62dd7993de0da56d0d186","name":"@athombv/jsdoc-template","dist-tags":{"latest":"1.7.0"},"versions":{"1.6.4":{"name":"@athombv/jsdoc-template","version":"1.6.4","author":{"name":"Athom B.V."},"license":"GPL-3.0","_id":"@athombv/jsdoc-template@1.6.4","maintainers":[{"name":"robinbolscher","email":"robinbolscher@gmail.com"},{"name":"athombv-github-actions","email":"sysadmin@athom.com"},{"name":"weejewel","email":"emile@emile.nl"}],"homepage":"https://github.com/athombv/homey-jsdoc-template#readme","bugs":{"url":"https://github.com/athombv/homey-jsdoc-template/issues"},"dist":{"shasum":"1e6c06069e3dd74c90bba0e85635ab7aec5da4a3","tarball":"https://registry.npmjs.org/@athombv/jsdoc-template/-/jsdoc-template-1.6.4.tgz","fileCount":109,"integrity":"sha512-AXIhvjRApt7tZhw07ZDug+ua6PeVfT8pnE+coNKKlZQQebbt2YL1cmUHe0AZQw4Dvm7IeMnol3Bo4gIKJJXgjQ==","signatures":[{"sig":"MEQCIA4tFeuSMlhKyyKIjBd9ubp0xiOsFOnabpmmlN5yV+aOAiBSz53PJoE+fgh/Nwg0iog2nErIJPaBrFZO7XzZfQMS0w==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":1267273},"main":"publish.js","gitHead":"d0a0b517e661909dfea0aef0e417136b9479d9cd","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"NODE_ENV=none webpack","watch":"NODE_ENV=none webpack --watch"},"_npmUser":{"name":"athombv-github-actions","email":"sysadmin@athom.com"},"repository":{"url":"git+https://github.com/athombv/homey-jsdoc-template.git","type":"git"},"_npmVersion":"11.11.0","description":"JSDoc template used for Athom (Homey) developer documentation.","directories":{},"_nodeVersion":"24.14.1","browserslist":["last 5 Chrome versions","last 5 Safari versions","last 5 Edge versions","last 5 Firefox versions","> 0.5% and not op_mini all and not ie <= 11"],"dependencies":{"taffydb":"^2.7.3","css-loader":"^5.2.4","highlight.js":"^10.7.2"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"precss":"^4.0.0","cssnano":"^5.0.2","postcss":"^8.2.14","webpack":"^5.37.0","url-loader":"^4.1.1","@babel/core":"^7.14.0","webpack-cli":"^4.6.0","autoprefixer":"^10.2.5","babel-loader":"^8.2.2","css-mqpacker":"^7.0.0","style-loader":"^2.0.0","postcss-loader":"^5.2.0","svg-url-loader":"^7.1.1","@babel/preset-env":"^7.14.1","sort-css-media-queries":"^1.5.4","mini-css-extract-plugin":"^1.6.0"},"_npmOperationalInternal":{"tmp":"tmp/jsdoc-template_1.6.4_1779098253791_0.4281265456115577","host":"s3://npm-registry-packages-npm-production"}},"1.7.0":{"name":"@athombv/jsdoc-template","version":"1.7.0","author":{"name":"Athom B.V."},"license":"GPL-3.0","_id":"@athombv/jsdoc-template@1.7.0","maintainers":[{"name":"robinbolscher","email":"robinbolscher@gmail.com"},{"name":"athombv-github-actions","email":"sysadmin@athom.com"},{"name":"weejewel","email":"emile@emile.nl"}],"homepage":"https://github.com/athombv/jsdoc-template#readme","bugs":{"url":"https://github.com/athombv/jsdoc-template/issues"},"dist":{"shasum":"7c487223bdd9910f9adc95fe40c96b0c7556e050","tarball":"https://registry.npmjs.org/@athombv/jsdoc-template/-/jsdoc-template-1.7.0.tgz","fileCount":109,"integrity":"sha512-eO4Kna1DCmRLMm4SwHYrEehQWkWDt72j88aMIjW+HOWuWV6Nu296VTLjZ5EeoeSrD0Q/QYUakr9TCJKJ8hwIBA==","signatures":[{"sig":"MEUCIQCIILfNk8Kvc42DgIMRhpsOrgPZ5DJZfsCYswb58fNuSQIgePemAlfV2R8iqv2N2V19zYO8KvLvaCIN0+tOjvNO7a4=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@athombv%2fjsdoc-template@1.7.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":1267267},"main":"publish.js","gitHead":"791d5bbf7298947e273b0722ba56c92c728a1ac7","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"NODE_ENV=none webpack","watch":"NODE_ENV=none webpack --watch"},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:0877efcf-5841-49e9-b18c-40aac1610465"}},"repository":{"url":"git+https://github.com/athombv/jsdoc-template.git","type":"git"},"_npmVersion":"11.12.1","description":"JSDoc template used for Athom (Homey) developer documentation.","directories":{},"_nodeVersion":"24.15.0","browserslist":["last 5 Chrome versions","last 5 Safari versions","last 5 Edge versions","last 5 Firefox versions","> 0.5% and not op_mini all and not ie <= 11"],"dependencies":{"taffydb":"^2.7.3","css-loader":"^5.2.4","highlight.js":"^10.7.2"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"precss":"^4.0.0","cssnano":"^5.0.2","postcss":"^8.2.14","webpack":"^5.37.0","url-loader":"^4.1.1","@babel/core":"^7.14.0","webpack-cli":"^4.6.0","autoprefixer":"^10.2.5","babel-loader":"^8.2.2","css-mqpacker":"^7.0.0","style-loader":"^2.0.0","postcss-loader":"^5.2.0","svg-url-loader":"^7.1.1","@babel/preset-env":"^7.14.1","sort-css-media-queries":"^1.5.4","mini-css-extract-plugin":"^1.6.0"},"_npmOperationalInternal":{"tmp":"tmp/jsdoc-template_1.7.0_1779098763170_0.8128576379796595","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2026-05-18T09:57:33.657Z","modified":"2026-09-09T14:13:29.789Z","1.6.4":"2026-05-18T09:57:33.957Z","1.7.0":"2026-05-18T10:06:03.410Z"},"bugs":{"url":"https://github.com/athombv/jsdoc-template/issues"},"author":{"name":"Athom B.V."},"license":"GPL-3.0","homepage":"https://github.com/athombv/jsdoc-template#readme","repository":{"url":"git+https://github.com/athombv/jsdoc-template.git","type":"git"},"description":"JSDoc template used for Athom (Homey) developer documentation.","maintainers":[{"email":"robinbolscher@gmail.com","name":"robinbolscher"},{"email":"sysadmin@athom.com","name":"athombv-github-actions"},{"email":"emile@emile.nl","name":"weejewel"},{"email":"jeroen.wienk@athom.nl","name":"jwienk-athom"}],"readme":"# Athom B.V. JSDoc Template\n\n## How to use this template\n\n1. Install as a dev dependency\n\n```bash\n$ npm i --save-dev @athombv/jsdoc-template\n```\n\n2. Create `./jsdoc.json`:\n\n```json\n{\n  \"opts\": {\n    \"mainpagetitle\": \"🚨 Your Project Name\",\n    \"template\": \"./node_modules/@athombv/jsdoc-template\"\n  },\n  \"source\": {\n    \"include\": [\n      \"./README.md\",\n      \"./lib\",\n      \"./index.js\"\n    ]\n  },\n  \"plugins\": [\n    \"plugins/markdown\"\n  ],\n  \"templates\": {\n    \"default\": {\n      \"outputSourceFiles\": false\n    }\n  }\n}\n```\n\n## Recommended NPM Scripts\n\nThis is the recommended approach of integrating this template in your project, additional to the steps above.\n\n```bash\n$ npm i --save-dev concurrently jsdoc jsdoc-ts-utils serve watch\n```\n\n2. Add scripts to `package.json`\n\n```json\n{\n  \"scripts\": {\n    \"serve\": \"concurrently \\\"serve build/\\\" \\\"npm run jsdoc:watch\\\"\",\n    \"build\": \"npm ci; npm run jsdoc:clean; npm run jsdoc;\",\n    \"jsdoc\": \"jsdoc --configure ./jsdoc.json --destination ./jsdoc/\",\n    \"jsdoc:clean\": \"rm -rf ./build\",\n    \"jsdoc:watch\": \"watch \\\"npm run jsdoc:clean && npm run jsdoc\\\" ./lib docs\"\n  }\n}\n```\n\n## How to make updates to template\n\n1. Clone this repository\n\n2. Link this repository to your current project by:\n\n```bash\nnpm link @athombv/jsdoc-template\n```\n\n> You have to relink the repository each time after you run `npm install`\n\n## Publishing\n1. Bump the version on `master` via the [Version workflow](https://github.com/athombv/jsdoc-template/actions/workflows/version.yaml).\n2. Merge `master` to `production` - this will automatically publish the release to npmjs.org via OIDC (Trusted Publisher).\n3. Create PRs in dependent repos via the [Update Dependents workflow](https://github.com/athombv/jsdoc-template/actions/workflows/update-dependents.yaml). This will automatically discover repos in the `athombv` org that use `@athombv/jsdoc-template` and open PRs to update them to the new version.\n\n\n## Configuration\n\n### Simple analytics\n\nTo add an alternative cname host for Simple Analytics add the following rule to `jsdoc.json` or `jsdocrc.json`\n\n```json\n{\n  \"opts\": {\n    \"simpleAnalyticsHost\": \"your-host.extension\"\n  }\n}\n```\n\n## Customization\n### Batches / images / videos\nIf you want to add batches a.o elements like images/ video in top of the readme.md it will break the large intro paragraph. Wrap your intro elements in `<header>` tags to avoid this. \nExample\n`readme.md`\n```\n    <header>\n    \n    # Your heading\n    \n    batches/images/etc\n    \n    </header>\n    \n    My first large paragraph\n```\n\n## Repositories using this template\n\n[GitHub Search](https://github.com/search?q=org%3Aathombv+%22%40athombv%2Fjsdoc-template%22+filename%3A%22package.json%22&type=code)\n","readmeFilename":"README.md"}