{"_id":"@2gis/ts-docs-generator","_rev":"6-7b570a5b78a315fa9ab5ec63877128fe","name":"@2gis/ts-docs-generator","dist-tags":{"latest":"0.2.0"},"versions":{"0.0.1":{"name":"@2gis/ts-docs-generator","version":"0.0.1","author":{"name":"2GIS WebMaps Team"},"license":"BSD-2-Clause","_id":"@2gis/ts-docs-generator@0.0.1","maintainers":[{"name":"artem.malko","email":"artem.malko@gmail.com"},{"name":"trufi","email":"stevemyz@gmail.com"},{"name":"lastw","email":"me@lastw.net"},{"name":"itanka9","email":"mbeloshitsky@gmail.com"},{"name":"alxart","email":"a.artemev@inbox.ru"},{"name":"vitaliy.gis","email":"vitaliy.gis@gmail.com"},{"name":"kuznetcoff","email":"mail@kuznetsov.it"},{"name":"kalyanov","email":"oleg1556@gmail.com"},{"name":"kto-to","email":"count@ngs.ru"},{"name":"nortren_developer","email":"nortren@inbox.ru"}],"dist":{"shasum":"815a5949c0c5fa2f502622630884d9d4c51f49ac","tarball":"https://registry.npmjs.org/@2gis/ts-docs-generator/-/ts-docs-generator-0.0.1.tgz","fileCount":6,"integrity":"sha512-AMpFYRgMRc8YtLR/PhQb4GNt6t7JhqkPKyS8/QlRVCyO9N6lgK7Rz+3TpjmmMvnqafV2vzRe11Rn7lWilCwqxw==","signatures":[{"sig":"MEUCIQD7sMxF2gO1NEAgJBtfhzikbVnppEjQCECzUGhMvvxezAIgEwepH1THAswNNZiIE1IPQ1oDQDBCoih+hDiGr407v3c=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":21170},"main":"dist/index.js","types":"dist/index.d.ts","volta":{"npm":"8.19.4","node":"18.20.8"},"engines":{"node":">=18"},"gitHead":"1eb11e90cf94cfda8f4f8a8e10941b0d9cc0baa2","scripts":{"test":"tsx test/index.ts","build":"tsc","prepublishOnly":"npm run build"},"_npmUser":{"name":"kalyanov","email":"oleg1556@gmail.com"},"_npmVersion":"10.8.2","description":"Documentation generator for 2GIS TS projects","directories":{},"_nodeVersion":"20.19.1","dependencies":{"@documentalist/client":"5.0.0","@documentalist/compiler":"5.0.0"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.7.0","typescript":"4.9.4","@types/node":"^20.11.0"},"_npmOperationalInternal":{"tmp":"tmp/ts-docs-generator_0.0.1_1747137577958_0.3989357483261611","host":"s3://npm-registry-packages-npm-production"}},"0.0.2":{"name":"@2gis/ts-docs-generator","version":"0.0.2","author":{"name":"2GIS WebMaps Team"},"license":"BSD-2-Clause","_id":"@2gis/ts-docs-generator@0.0.2","maintainers":[{"name":"artem.malko","email":"artem.malko@gmail.com"},{"name":"trufi","email":"stevemyz@gmail.com"},{"name":"lastw","email":"me@lastw.net"},{"name":"itanka9","email":"mbeloshitsky@gmail.com"},{"name":"alxart","email":"a.artemev@inbox.ru"},{"name":"vitaliy.gis","email":"vitaliy.gis@gmail.com"},{"name":"kuznetcoff","email":"mail@kuznetsov.it"},{"name":"kalyanov","email":"oleg1556@gmail.com"},{"name":"kto-to","email":"count@ngs.ru"},{"name":"nortren_developer","email":"nortren@inbox.ru"}],"dist":{"shasum":"af7420e2c2e36a76b3decdddb74fd0c00f4e67cf","tarball":"https://registry.npmjs.org/@2gis/ts-docs-generator/-/ts-docs-generator-0.0.2.tgz","fileCount":6,"integrity":"sha512-WcGIV04tp/M9GCt2MetA2NNzlF6GX2UhOlhz2ZCM+pEN4sH9ozcaA/J2bRjQnymPKaH8ds9rgwoa8HRvtbWmwA==","signatures":[{"sig":"MEYCIQDVmJa6DhHCKkP+URSuAZSqp9tcDOg6fdvY2h2jIYsWtAIhANt9XaYnRdf5boVVlvef4MRrOa4aAaeh7Khb5+ZUIZHC","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":22089},"main":"dist/index.js","types":"dist/index.d.ts","volta":{"npm":"8.19.4","node":"18.20.8"},"engines":{"node":">=18"},"gitHead":"1888f0d9ff31e5bda99bcfc5aea19a2e0835db4a","scripts":{"lint":"oxlint --deny-warnings","test":"tsx test/index.ts","build":"tsc","lint:fix":"oxlint --fix","prepublishOnly":"npm run build"},"_npmUser":{"name":"kalyanov","email":"oleg1556@gmail.com"},"_npmVersion":"10.8.2","description":"Documentation generator for 2GIS TS projects","directories":{},"_nodeVersion":"20.19.1","dependencies":{"@documentalist/client":"5.0.0","@documentalist/compiler":"5.0.0"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.7.0","oxlint":"^0.16.10","typescript":"4.9.4","@types/node":"^20.11.0"},"_npmOperationalInternal":{"tmp":"tmp/ts-docs-generator_0.0.2_1747138718724_0.6319076931345795","host":"s3://npm-registry-packages-npm-production"}},"0.1.0":{"name":"@2gis/ts-docs-generator","version":"0.1.0","author":{"name":"2GIS WebMaps Team"},"license":"BSD-2-Clause","_id":"@2gis/ts-docs-generator@0.1.0","maintainers":[{"name":"artem.malko","email":"artem.malko@gmail.com"},{"name":"trufi","email":"stevemyz@gmail.com"},{"name":"lastw","email":"me@lastw.net"},{"name":"itanka9","email":"mbeloshitsky@gmail.com"},{"name":"alxart","email":"a.artemev@inbox.ru"},{"name":"vitaliy.gis","email":"vitaliy.gis@gmail.com"},{"name":"kuznetcoff","email":"mail@kuznetsov.it"},{"name":"kalyanov","email":"oleg1556@gmail.com"},{"name":"kto-to","email":"count@ngs.ru"},{"name":"nortren_developer","email":"nortren@inbox.ru"}],"dist":{"shasum":"a9f430f42cb50e22128b2fbbb0b8a98be4e83634","tarball":"https://registry.npmjs.org/@2gis/ts-docs-generator/-/ts-docs-generator-0.1.0.tgz","fileCount":6,"integrity":"sha512-yVkibpil7UjOn/RkEJRfxu4axTrYWWq+4F0HGjioE8h4sPTykBwZhHQ2YmzVTUF/TYEo1/mn/eqcODG4aGvqeQ==","signatures":[{"sig":"MEQCIDlwKskQH5wiZ+H0NxkQiIlOUNKjzkuoa/mtuUxO8e1SAiAN8sorwxXZvfybd15kXuYb0cN3o0saXMKfiFfrpPp01Q==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":23319},"main":"dist/index.js","types":"dist/index.d.ts","volta":{"npm":"8.19.4","node":"18.20.8"},"engines":{"node":">=18"},"gitHead":"833ce64b1cff5b1fc8796860a661748d6e6c6ec1","scripts":{"lint":"oxlint --deny-warnings","test":"tsx test/index.ts","build":"tsc","lint:fix":"oxlint --fix","prepublishOnly":"npm run build"},"_npmUser":{"name":"kalyanov","email":"oleg1556@gmail.com"},"_npmVersion":"10.8.2","description":"Documentation generator for 2GIS TS projects","directories":{},"_nodeVersion":"20.19.2","dependencies":{"@documentalist/client":"5.0.0","@documentalist/compiler":"5.0.0"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.7.0","oxlint":"^0.16.10","typescript":"4.9.4","@types/node":"^20.11.0"},"_npmOperationalInternal":{"tmp":"tmp/ts-docs-generator_0.1.0_1747804995853_0.3593757221307672","host":"s3://npm-registry-packages-npm-production"}},"0.2.0":{"name":"@2gis/ts-docs-generator","version":"0.2.0","author":{"name":"2GIS WebMaps Team"},"license":"BSD-2-Clause","_id":"@2gis/ts-docs-generator@0.2.0","maintainers":[{"name":"artem.malko","email":"artem.malko@gmail.com"},{"name":"trufi","email":"stevemyz@gmail.com"},{"name":"lastw","email":"me@lastw.net"},{"name":"itanka9","email":"mbeloshitsky@gmail.com"},{"name":"alxart","email":"a.artemev@inbox.ru"},{"name":"vitaliy.gis","email":"vitaliy.gis@gmail.com"},{"name":"kuznetcoff","email":"mail@kuznetsov.it"},{"name":"kalyanov","email":"oleg1556@gmail.com"},{"name":"kto-to","email":"count@ngs.ru"},{"name":"nortren_developer","email":"nortren@inbox.ru"}],"dist":{"shasum":"f8125df74896894b37491b10500eef88f6822cf4","tarball":"https://registry.npmjs.org/@2gis/ts-docs-generator/-/ts-docs-generator-0.2.0.tgz","fileCount":6,"integrity":"sha512-bzT3X2aazUzKb0mrtjkeDI2h8w0GDSKC9HNCtWRLURtMR6UL17Sp0Sd2AbVxCAgZKlAN5nhm4ZvbmQFtpEyUTg==","signatures":[{"sig":"MEUCID9hWMr3MB3qljuDVXoLpoZ5UDJ0Uhkc65B+nDxm1befAiEAwhiUBwD8a7ULoFEGXfVDiXEulzidbmx/B3sj45lAkL8=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":23477},"main":"dist/index.js","types":"dist/index.d.ts","volta":{"npm":"8.19.4","node":"18.20.8"},"engines":{"node":">=18"},"gitHead":"9071c12dd5ec28498080899127824038e792f480","scripts":{"lint":"oxlint --deny-warnings","test":"tsx test/index.ts","build":"tsc","lint:fix":"oxlint --fix","prepublishOnly":"npm run build"},"_npmUser":{"name":"kalyanov","email":"oleg1556@gmail.com"},"_npmVersion":"10.8.2","description":"Documentation generator for 2GIS TS projects","directories":{},"_nodeVersion":"20.19.6","dependencies":{"@documentalist/client":"5.0.0","@documentalist/compiler":"5.0.0"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.7.0","oxlint":"^0.16.10","typescript":"4.9.4","@types/node":"^20.11.0"},"_npmOperationalInternal":{"tmp":"tmp/ts-docs-generator_0.2.0_1765735000266_0.10791055861687426","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2025-05-13T11:59:37.897Z","modified":"2026-09-04T09:00:36.740Z","0.0.1":"2025-05-13T11:59:38.138Z","0.0.2":"2025-05-13T12:18:38.905Z","0.1.0":"2025-05-21T05:23:16.046Z","0.2.0":"2025-12-14T17:56:40.416Z"},"author":{"name":"2GIS WebMaps Team"},"license":"BSD-2-Clause","description":"Documentation generator for 2GIS TS projects","maintainers":[{"email":"artem.malko@gmail.com","name":"artem.malko"},{"email":"stevemyz@gmail.com","name":"trufi"},{"email":"me@lastw.net","name":"lastw"},{"email":"mbeloshitsky@gmail.com","name":"itanka9"},{"email":"a.artemev@inbox.ru","name":"alxart"},{"email":"vitaliy.gis@gmail.com","name":"vitaliy.gis"},{"email":"mail@kuznetsov.it","name":"kuznetcoff"},{"email":"oleg1556@gmail.com","name":"kalyanov"},{"email":"count@ngs.ru","name":"kto-to"},{"email":"m.novoselcev@2gis.ru","name":"mnovoseltsev"}],"readme":"# TS docs generator\n\nDocumentation generator for TypeScript projects of 2GIS.\n\n## Installation\n\n```bash\nnpm i @2gis/ts-docs-generator\n```\n\n## Usage\n\n### CommonJS\n\n```js\nconst { generateDocs } = require(\"@2gis/ts-docs-generator\");\n\ngenerateDocs(config).then((result) => {\n    // Access generated documentation\n    // result.manifest - Contains metadata about the documentation\n    // result.reference - Contains the generated API documentation\n});\n```\n\n## Development\n\n```bash\n# Install dependencies\nnpm install\n\n# Run tests\nnpm test\n\n# Build the project\nnpm run build\n```\n\n## Release Process\n\nTo release a new version:\n\n1. Create a tag `vX.Y.Z` in GitLab (where X.Y.Z is the semantic version number)\n2. Push the tag to the repository\n3. The CI/CD pipeline will automatically build and publish the package\n","readmeFilename":"README.md"}