{"_id":"@anshsinghsonkhia/pumki-docgen","_rev":"2-11b7ee76ae4b1d035bbf3a4cef7b0229","name":"@anshsinghsonkhia/pumki-docgen","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@anshsinghsonkhia/pumki-docgen","version":"1.0.0","keywords":["cli","pumki","pumki-ui","documentation","doc-gen","docs","docs-generator"],"author":{"name":"Ansh Singh Sonkhia"},"license":"MIT","_id":"@anshsinghsonkhia/pumki-docgen@1.0.0","maintainers":[{"name":"anshsinghsonkhia","email":"anshssonkhia@gmail.com"}],"homepage":"https://github.com/AnshSinghSonkhia/pumki-docgen#readme","bugs":{"url":"https://github.com/AnshSinghSonkhia/pumki-docgen/issues"},"bin":{"pumki-docgen":"dist/bin/pumki-docgen.js"},"dist":{"shasum":"110306987bdd8873b496eb87d8383453bee4762f","tarball":"https://registry.npmjs.org/@anshsinghsonkhia/pumki-docgen/-/pumki-docgen-1.0.0.tgz","fileCount":9,"integrity":"sha512-inmjOHoRuPrhqkAe3duFbVTqx2SKJlhouV2WJTLGPutplwK0faqDQ4NDRudFGJWS/qbdFFkkl81ZCBMH/m6wzw==","signatures":[{"sig":"MEUCIQDWHTGW+86Uq2jocAu6Maagnu3B4Tgy9Vus3VwawrdQhQIgA3D2ZFHLxHS9fUc1RfC6/Ysl1Ol/lXA8VAOIU9BGH7E=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":7954},"type":"module","gitHead":"da4b1952f3bc33976a4716d7f80b9729b3277409","scripts":{"dev":"ts-node bin/pumki-docgen.ts sample/HoverCard.tsx sample/HoverCard.mdx","build":"tsc"},"_npmUser":{"name":"anshsinghsonkhia","email":"anshssonkhia@gmail.com"},"repository":{"url":"git+https://github.com/AnshSinghSonkhia/pumki-docgen.git","type":"git"},"_npmVersion":"10.8.2","description":"Private CLI to generate MDX docs from TSX components for pumki-ui","directories":{},"_nodeVersion":"20.19.4","dependencies":{"fs":"^0.0.1-security","path":"^0.12.7","ts-morph":"^22.0.0","typescript":"^5.4.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"ts-node":"^10.9.1"},"_npmOperationalInternal":{"tmp":"tmp/pumki-docgen_1.0.0_1755457135520_0.39599248343016313","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@anshsinghsonkhia/pumki-docgen","version":"1.0.1","description":"Private CLI to generate MDX docs from TSX components for pumki-ui","type":"module","bin":{"pumki-docgen":"dist/bin/pumki-docgen.js"},"publishConfig":{"access":"public"},"scripts":{"dev":"ts-node bin/pumki-docgen.ts sample/HoverCard.tsx sample/HoverCard.mdx","build":"tsc"},"repository":{"type":"git","url":"git+https://github.com/AnshSinghSonkhia/pumki-docgen.git"},"keywords":["cli","pumki","pumki-ui","documentation","doc-gen","docs","docs-generator"],"author":{"name":"Ansh Singh Sonkhia"},"license":"MIT","bugs":{"url":"https://github.com/AnshSinghSonkhia/pumki-docgen/issues"},"homepage":"https://github.com/AnshSinghSonkhia/pumki-docgen#readme","dependencies":{"fs":"^0.0.1-security","path":"^0.12.7","ts-morph":"^22.0.0","typescript":"^5.4.0"},"devDependencies":{"ts-node":"^10.9.1"},"_id":"@anshsinghsonkhia/pumki-docgen@1.0.1","gitHead":"7c17671f9a0cf69e49203469402e393c7b5ea1bf","_nodeVersion":"20.19.4","_npmVersion":"10.8.2","dist":{"integrity":"sha512-ZyPyWsjbKM+yXMj6ePVPEXN0foKPdeqKL9bV2wrsJOwS/3h0zXMQ0AVgJgVcgmjNeKErqhwedFgbOeN/nUGfqQ==","shasum":"82e4999c9513f9d41b67e1b917cc9b2d757db025","tarball":"https://registry.npmjs.org/@anshsinghsonkhia/pumki-docgen/-/pumki-docgen-1.0.1.tgz","fileCount":9,"unpackedSize":7987,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDwj7V9u/pfAGK2m6RuDXcPfn2Ws3JbsxQ1pIcBfx5q+AIhAL75S7b9swWfezCmQwiahCLpsPEyfE+zrz7irXzwTzN3"}]},"_npmUser":{"name":"anshsinghsonkhia","email":"anshssonkhia@gmail.com"},"directories":{},"maintainers":[{"name":"anshsinghsonkhia","email":"anshssonkhia@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/pumki-docgen_1.0.1_1755513382573_0.9678228280965353"},"_hasShrinkwrap":false}},"time":{"created":"2025-08-17T18:58:55.426Z","modified":"2025-08-18T10:36:22.931Z","1.0.0":"2025-08-17T18:58:55.749Z","1.0.1":"2025-08-18T10:36:22.777Z"},"bugs":{"url":"https://github.com/AnshSinghSonkhia/pumki-docgen/issues"},"author":{"name":"Ansh Singh Sonkhia"},"license":"MIT","homepage":"https://github.com/AnshSinghSonkhia/pumki-docgen#readme","keywords":["cli","pumki","pumki-ui","documentation","doc-gen","docs","docs-generator"],"repository":{"type":"git","url":"git+https://github.com/AnshSinghSonkhia/pumki-docgen.git"},"description":"Private CLI to generate MDX docs from TSX components for pumki-ui","maintainers":[{"name":"anshsinghsonkhia","email":"anshssonkhia@gmail.com"}],"readme":"# pumki-docgen\r\n\r\nGenerate beautiful MDX documentation for your React components automatically.\r\n\r\n## Features\r\n- Parses TypeScript React component props\r\n- Generates ready-to-use MDX docs with usage, installation, and props tables\r\n- CLI for easy integration\r\n\r\n## Installation\r\n\r\nYou can use `pumki-docgen` via npx (no install required) or install it globally:\r\n\r\n```bash\r\nnpx pumki-docgen <component.tsx> <output.mdx>\r\n# or install globally\r\nnpm install -g pumki-docgen\r\n# or\r\npnpm add -g pumki-docgen\r\n```\r\n\r\n## Usage\r\n\r\n```bash\r\nnpx pumki-docgen <component.tsx> <output.mdx>\r\n```\r\n\r\nExample (real usage):\r\n\r\n```bash\r\nnpx pumki-docgen components/pumki-ui/animations/ballpit.tsx content/animations/ballpit.mdx\r\n```\r\n\r\nThis will generate an MDX documentation file for your component, including:\r\n- Usage example\r\n- Installation instructions\r\n- Props table (auto-generated from your TypeScript interface)\r\n\r\n## How it works\r\n- Parses the component file for an interface ending with `Props`\r\n- Extracts prop names, types, and optional/default status\r\n- Generates an MDX file with a preview, installation, usage, and props table\r\n\r\n## CLI Reference\r\n\r\n```\r\nnpx pumki-docgen <component.tsx> <output.mdx>\r\n```\r\n- `<component.tsx>`: Path to your React component file\r\n- `<output.mdx>`: Path to the output MDX file\r\n\r\n## Example Output\r\nSee `HoverCard.mdx` for a sample generated file.\r\n\r\n## License\r\nMIT","readmeFilename":"README.md"}