{"_id":"@cadelwatson/nanodoc","_rev":"2-36353aea8725bd3acfe508c69ada4978","name":"@cadelwatson/nanodoc","dist-tags":{"latest":"0.1.1"},"versions":{"0.1.0":{"name":"@cadelwatson/nanodoc","version":"0.1.0","_id":"@cadelwatson/nanodoc@0.1.0","maintainers":[{"name":"cadelwatson","email":"cadel@cadelwatson.com"}],"bin":{"nanodoc":"dist/cli.js"},"dist":{"shasum":"e0fb068c0c53dae519012714f4817afbc723ce7a","tarball":"https://registry.npmjs.org/@cadelwatson/nanodoc/-/nanodoc-0.1.0.tgz","fileCount":30,"integrity":"sha512-hkBi8kZi23RXYSo3b5F1DHp89X2/9flLK6bVlbEJrZG6awpl0GrHcZ/udwvRNJPhXayUKhHErL8nG81GzR2PPQ==","signatures":[{"sig":"MEYCIQDwuT04Z3VLP+GGW3CBqq2yUfaeEScbn40RMJXtrdMX3AIhAMQf0d5RFFRoCa4n/Yc2xtm6JPMWiZC3a0f3RrLtpKfw","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":25647},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","engines":{"node":">=20"},"exports":{".":{"types":"./dist/index.d.ts","default":"./dist/index.js"}},"gitHead":"4fcb51424cf221a047d4775cd657e4d856c60596","scripts":{"dev":"tsx src/cli.ts","test":"vitest run","build":"tsc -p tsconfig.json","prepack":"npm run build","typecheck":"tsc -p tsconfig.json --noEmit","test:watch":"vitest"},"_npmUser":{"name":"cadelwatson","email":"cadel@cadelwatson.com"},"_npmVersion":"10.8.2","description":"Literate documentation generator","directories":{},"_nodeVersion":"20.17.0","dependencies":{"mermaid":"^11.12.3","commander":"^14.0.3","mime-types":"^3.0.2","typescript":"^5.9.3","markdown-it":"^14.1.1"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.21.0","vitest":"^4.0.18","@types/node":"^25.3.0","@types/mime-types":"^3.0.1","@types/markdown-it":"^14.1.2"},"_npmOperationalInternal":{"tmp":"tmp/nanodoc_0.1.0_1771810731698_0.09247790969761027","host":"s3://npm-registry-packages-npm-production"}},"0.1.1":{"name":"@cadelwatson/nanodoc","version":"0.1.1","description":"Literate documentation generator","type":"module","main":"./dist/index.js","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","default":"./dist/index.js"}},"bin":{"nanodoc":"dist/cli.js"},"publishConfig":{"access":"public"},"scripts":{"build":"tsc -p tsconfig.json","dev":"tsx src/cli.ts","prepack":"npm run build","test":"vitest run","test:watch":"vitest","typecheck":"tsc -p tsconfig.json --noEmit"},"engines":{"node":">=20"},"dependencies":{"commander":"^14.0.3","markdown-it":"^14.1.1","mermaid":"^11.12.3","mime-types":"^3.0.2","tufte-css":"^1.8.0","typescript":"^5.9.3"},"devDependencies":{"@types/markdown-it":"^14.1.2","@types/mime-types":"^3.0.1","@types/node":"^25.3.0","tsx":"^4.21.0","vitest":"^4.0.18"},"_id":"@cadelwatson/nanodoc@0.1.1","gitHead":"7afedf6457b03282f39d644c73b1093e78abd1d3","_nodeVersion":"20.17.0","_npmVersion":"10.8.2","dist":{"integrity":"sha512-l0LY1I9m9/7cuKCglIBoWMk38TfzFj2+3xV5Fi3DqCc+rOcuZdaHOy02clgaV8GB+8IkxUNMBH8Ef+61a0ElcQ==","shasum":"61d628f67afbe0fc6c35f4b1355adb115843a85a","tarball":"https://registry.npmjs.org/@cadelwatson/nanodoc/-/nanodoc-0.1.1.tgz","fileCount":32,"unpackedSize":29840,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIEQuWEUKS7+lQC00pjSkEmyV+BVVbZZ1icS4jwLopoT7AiBl5is0e0+XCOkEvnNpuvuJsCPE5r3INbn7a22fYdDJ8g=="}]},"_npmUser":{"name":"cadelwatson","email":"cadel@cadelwatson.com"},"directories":{},"maintainers":[{"name":"cadelwatson","email":"cadel@cadelwatson.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/nanodoc_0.1.1_1771811792082_0.2326790812223163"},"_hasShrinkwrap":false}},"time":{"created":"2026-02-23T01:38:51.575Z","modified":"2026-02-23T01:56:32.346Z","0.1.0":"2026-02-23T01:38:51.846Z","0.1.1":"2026-02-23T01:56:32.227Z"},"description":"Literate documentation generator","maintainers":[{"name":"cadelwatson","email":"cadel@cadelwatson.com"}],"readme":"# nanodoc\n\nGenerate a single self-contained HTML document from source-code comments.\n\n## Requirements\n\n- Node.js 20+\n- Python on `PATH` (`python` or `python3`)\n\n## Install\n\n```bash\nnpm install\nnpm run build\n```\n\n## Usage\n\n```bash\nnanodoc <entrypoint>\n```\n\nOr with a config file:\n\n```bash\nnanodoc --config ./nanodoc.json\n```\n\nor during development:\n\n```bash\nnpm run dev -- <entrypoint>\n```\n\nThis writes `<entrypoint-name>.html` to the current working directory.\n\nWhen using `--config`, each generated HTML file is written into the config's\n`outputDir` (created automatically if missing).\n\n## Config File\n\nUse a JSON file with this shape:\n\n```json\n{\n  \"entrypoints\": [\"./src/main.ts\", \"./src/guide.py\"],\n  \"outputDir\": \"./docs\"\n}\n```\n\nPaths in `entrypoints` and `outputDir` are resolved relative to the config file.\n\n## Supported sources\n\n- TypeScript: `.ts`, `.tsx`\n- Python: `.py`\n\n## Included comment types\n\n- TypeScript: block comments (`/* ... */`, `/** ... */`)\n- Python: docstrings + `#` comment blocks opted in with `@doc`\n\nUse `@nodoc` on the first line of an included comment to suppress it.\n\n## Features\n\n- Markdown rendering for extracted prose\n- First included comment first line becomes document `<h1>`\n- One-level appendix inclusion from Markdown links to source files\n- Mermaid fenced blocks (` ```mermaid `)\n- Local Markdown images inlined as base64 `data:` URLs\n- Tufte CSS typography and layout styling\n- Single self-contained HTML output (inline CSS/JS/assets)\n","readmeFilename":"README.md"}