{"_id":"@blazed-space/blz-typedoc-theme","_rev":"1-42b72f24059d88fa678be890eccbeb86","name":"@blazed-space/blz-typedoc-theme","dist-tags":{"latest":"0.0.2"},"versions":{"0.0.1":{"name":"@blazed-space/blz-typedoc-theme","version":"0.0.1","main":"dist/index.js","repository":{"type":"git","url":"git+https://github.com/blazed-space/blz-typedoc-theme.git"},"author":{"name":"Blazed Labs LLC","email":"hello@blazed.space"},"license":"MIT","keywords":["typedoc-theme"],"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"engines":{"node":">= 14"},"devDependencies":{"@types/node":"^18.15.10","autoprefixer":"^10.4.14","gh-pages":"^5.0.0","postcss":"^8.4.27","prettier":"^2.8.8","tailwindcss":"^3.3.3","typedoc":"^0.24.8","typescript":"^5.1.3"},"peerDependencies":{"typedoc":"^0.24.8"},"scripts":{"ts-check":"tsc --noEmit","build":"tsc","build:tailwind":"npx tailwindcss -o assets/build.min.css --minify","example:build":"tsc && cd example && npm install && npm run build:docs","example:deploy":"gh-pages -d example/docs"},"gitHead":"bede49cd2446e0ac8586d4e4968e4ec50f5f6852","description":"[![Built by Blazed Labs \"Built by Blazed Labs\"](https://img.shields.io/badge/Built%20By-Blazed%20Labs-red?logo=data:image/webp;base64,UklGRjYBAABXRUJQVlA4WAoAAAAQAAAAHwAAHwAAQUxQSN8AAAABgGPb2rHnM36Vsd0ZtTMGO2WGYJuVW9t2JpDKtivr14snGEBETADzn3KCIAiiKEockLZiZ","bugs":{"url":"https://github.com/blazed-space/blz-typedoc-theme/issues"},"homepage":"https://github.com/blazed-space/blz-typedoc-theme#readme","_id":"@blazed-space/blz-typedoc-theme@0.0.1","_nodeVersion":"20.5.1","_npmVersion":"9.6.5","dist":{"integrity":"sha512-C/rn6dMGMc3o88zRCCb5cW2u67BXBgSDHyzHPEi0cjVwm7nSOGyBTD7nGHDIMhb2mKHyBEv185945TUhcdC+Ag==","shasum":"3b3a77051bbe929f18a27d4a37b49f29696865d3","tarball":"https://registry.npmjs.org/@blazed-space/blz-typedoc-theme/-/blz-typedoc-theme-0.0.1.tgz","fileCount":16,"unpackedSize":27305,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDkRfInQ+KndNQuOM+9o8PaUPLLOH+LLAOhLHIB3b8WqAiEA9IT5nsln7y6AGELYHqk5LltohwtsltsMiXlm9rRAq9U="}]},"_npmUser":{"name":"blazed-labs","email":"hello@blazed.space"},"directories":{},"maintainers":[{"name":"blazed-labs","email":"hello@blazed.space"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/blz-typedoc-theme_0.0.1_1691835609891_0.6915675546035964"},"_hasShrinkwrap":false},"0.0.2":{"name":"@blazed-space/blz-typedoc-theme","version":"0.0.2","main":"./dist/index.js","types":"./dist/types/main.d.ts","description":"Typedoc theme made by Blazed Labs LLC (support v0.24).","repository":{"type":"git","url":"git+https://github.com/blazed-space/blz-typedoc-theme.git"},"homepage":"https://blz-typedoc-theme.netlify.app/","author":{"name":"Blazed Labs LLC","email":"hello@blazed.space"},"license":"MIT","keywords":["typedoc-theme"],"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"engines":{"node":">= 14"},"devDependencies":{"@types/node":"^18.15.10","typedoc":"^0.24.8","typescript":"^5.1.3"},"peerDependencies":{"typedoc":"^0.24.8"},"scripts":{"ts-check":"tsc --noEmit","lib:build":"tsc","lib:deploy":"npm run lib:build && npm publish","example:build":"npm run lib:build && cd example && npm install && npm run build:docs","example:serve":"cd example/docs && npx static-server -p 3020","docs:build":"cd docs && npm install && npm run build","docs:serve":"cd docs && npm run serve"},"gitHead":"35969544fe6e9037d95cb03e8250d1b7bb97c3a1","bugs":{"url":"https://github.com/blazed-space/blz-typedoc-theme/issues"},"_id":"@blazed-space/blz-typedoc-theme@0.0.2","_nodeVersion":"20.5.1","_npmVersion":"9.6.5","dist":{"integrity":"sha512-4CSh/EU7OeI8Wp8ZiHUKjkFLcHiQ9x/Lwuz7QAVO2gw7Ss+LR+a+Q+tWnyvqaAuLW+YAwFtUvlmqAIR1tyAUDg==","shasum":"c732b9a139a421ca8388bcdc8769ef46313eef4e","tarball":"https://registry.npmjs.org/@blazed-space/blz-typedoc-theme/-/blz-typedoc-theme-0.0.2.tgz","fileCount":28,"unpackedSize":31859,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCd86rfStsKd/QqKk7GvjQPNiUoRFbGcPeQfMHCpuF1NAIhAKBREyCy35kLvLCCHdS7HHOTChG8UlgoiDBO2/JxS1x6"}]},"_npmUser":{"name":"blazed-labs","email":"hello@blazed.space"},"directories":{},"maintainers":[{"name":"blazed-labs","email":"hello@blazed.space"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/blz-typedoc-theme_0.0.2_1691848548303_0.8212106318470169"},"_hasShrinkwrap":false}},"time":{"created":"2023-08-12T10:20:09.791Z","0.0.1":"2023-08-12T10:20:10.067Z","modified":"2023-08-12T13:55:48.742Z","0.0.2":"2023-08-12T13:55:48.557Z"},"maintainers":[{"name":"blazed-labs","email":"hello@blazed.space"}],"description":"Typedoc theme made by Blazed Labs LLC (support v0.24).","homepage":"https://blz-typedoc-theme.netlify.app/","keywords":["typedoc-theme"],"repository":{"type":"git","url":"git+https://github.com/blazed-space/blz-typedoc-theme.git"},"author":{"name":"Blazed Labs LLC","email":"hello@blazed.space"},"bugs":{"url":"https://github.com/blazed-space/blz-typedoc-theme/issues"},"license":"MIT","readme":"# blz-typedoc-theme\r\n\r\n![\"Screenshot\" Screenshot](Screenshot.png)\r\n\r\nTypedoc theme made by Blazed Labs LLC (support v0.24).\r\n\r\n* [View Live Demo](https://blz-typedoc-theme.netlify.app/)\r\n\r\n[![Built by Blazed Labs \"Built by Blazed Labs\"](https://img.shields.io/badge/Built%20By-Blazed%20Labs-red?logo=data:image/webp;base64,UklGRjYBAABXRUJQVlA4WAoAAAAQAAAAHwAAHwAAQUxQSN8AAAABgGPb2rHnM36Vsd0ZtTMGO2WGYJuVW9t2JpDKtivr14snGEBETADzn3KCIAiiKEockLZiZHh4ZHRsfCYTSO40op+SgRifQ9SwAqUuoioYaHn2x2ZQtWDSBKoZTBxDtYAJI6hOMHkS1cNDRdygzsOBbBaN2BEDCFf0jXvPAYm+NRIe+APYrhiJu7RUXOk32WsGVdy9kXLLj8J+w0jdoRDxlUb6p3iiuAcA46YXgTJkBG1gcd5nMLvOuOBHmIdAnOsezKE7js19h3jL53CMNntkaZF8aak3RcMQiyo1z/yXAFZQOCAwAAAA0AIAnQEqIAAgAD5tJptNpCEiopQAgA2JaQAATCggAAD9s//7f+1P//sZyP/OOAAA)](https://blazedlabs.com/)\r\n\r\n## Using This Theme\r\nEither clone this repo and copy the /example directory, or:\r\n1. Install typedoc & blz-typedoc-theme\r\n```shell\r\nnpm install typedoc @blazed-space/blz-typedoc-theme\r\n```\r\n2. Create a typedoc config (typedoc.json)\r\n```json\r\n{\r\n  \"$schema\": \"https://typedoc.org/schema.json\",\r\n  \"includeVersion\": true,\r\n  \"plugin\": [\"@blazed-space/blz-typedoc-theme\"],\r\n  \"theme\": \"my-theme\",\r\n  \"entryPoints\": [\"./src/index.ts\"],\r\n  \"out\": \"./docs\"\r\n}\r\n```\r\n3. Be sure to create a /media folder, and at minimum add a favicon.ico, manifest.json, and /styles/global.css.\r\n4. To build documentation, add the following scripts to your **package.json**:\r\n```json\r\n{\r\n    \"scripts\": {\r\n        \"docs:build\": \"npx typedoc\",\r\n        \"docs:serve\": \"cd docs && npx static-server\"\r\n    }\r\n}\r\n```\r\n5. You can now build docs using the command:\r\n```shell\r\nnpm run docs:build\r\n```\r\n6. Once built, you can open the .html files directly in the browser (not reccommended) or you can run a local static server with the following command:\r\n```shell\r\nnpm run docs:serve\r\n```\r\n\r\n## Local Development\r\n1. To develop this theme locally, first clone the GitHub repo\r\n```shell\r\ngit clone https://github.com/blazed-space/blz-typedoc-theme\r\n```\r\n2. Next, install dependencies with NPM:\r\n```shell\r\nnpm install\r\n```\r\n3. Now you can build the library:\r\n```shell\r\nnpm run lib:build\r\n```\r\n4. And build the example site:\r\n```shell\r\nnpm run example:build\r\n```\r\n5. To serve the example site locally,\r\n```shell\r\nnpm run example:serve\r\n```","readmeFilename":"README.md"}