{"_id":"hsdoc","_rev":"30-08360203fc13c78b9dbf01b9cb1802f2","name":"hsdoc","dist-tags":{"latest":"0.14.2"},"versions":{"0.13.8":{"name":"hsdoc","version":"0.13.8","keywords":["documentation"],"author":{"name":"Zack Bloom","email":"zbloom@hubspot.com"},"license":"MIT","_id":"hsdoc@0.13.8","maintainers":[{"name":"hs","email":"zbloom@hubspot.com"}],"bin":{"hsdoc":"run.js"},"dist":{"shasum":"682edea59c44afe05e1f77c0d7406cc88ee1a178","tarball":"https://registry.npmjs.org/hsdoc/-/hsdoc-0.13.8.tgz","integrity":"sha512-76tGGwquGUCDSdrs6vFva/myof2ORPwhKiNxBFyr/0XO9zzrVjO0JiTlKGeOgdwMipYJkrqvrc8X/30lYSK5RA==","signatures":[{"sig":"MEUCIGEPCtYa1ct9Mc2431O1vEn1Izr9byQqZpl15FTjbTrlAiEAp2SHl4n1a/1r4hAK9FqRP/vinjbnQ8KTnJJNuVnYT0g=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}]},"main":"documenter.coffee","_from":".","_npmUser":{"name":"hs","email":"zbloom@hubspot.com"},"_npmVersion":"1.4.4","description":"Build docs for HubSpot projects using Docco","directories":{},"dependencies":{"q":"~0.9.6","glob":"~3.1.17","jade":"~0.28.2","temp":"~0.6.0","async":"~0.2.9","colors":"~0.6.0-1","marked":"~0.2.9","mkdirp":"~0.3.5","watchr":"~2.4.3","libyaml":"~0.2.1","commander":"~1.1.1","underscore":"~1.4.3","graceful-fs":"~2.0.1","highlight.js":"~7.3.0","coffee-script":"~1.4.0"},"devDependencies":{"request":"~2.27.0","liveconfig":"~0.1.9"}},"0.13.9":{"name":"hsdoc","version":"0.13.9","keywords":["documentation"],"author":{"name":"Zack Bloom","email":"zbloom@hubspot.com"},"license":"MIT","_id":"hsdoc@0.13.9","maintainers":[{"name":"hs","email":"zbloom@hubspot.com"}],"bin":{"hsdoc":"run.js"},"dist":{"shasum":"75eab2198802008e4a26533e31a4037a099874b4","tarball":"https://registry.npmjs.org/hsdoc/-/hsdoc-0.13.9.tgz","integrity":"sha512-5RlK3gyXf4+nyRqDG3yKVv+WkGlGdfJjaDium/wnkOmoqy10B2Hcf4VGCv7vFfXs43XaEFFAH14voaQwNao56A==","signatures":[{"sig":"MEQCIG+5oWMncoFyGMYplX2Xm/DQxLfA+lBUOrr6B4VaYopjAiB1JrrKZWXJT5J9A6VuSxV5LjoTEJMCieypibDdr/wvEg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}]},"main":"documenter.coffee","_from":".","_npmUser":{"name":"hs","email":"zbloom@hubspot.com"},"_npmVersion":"1.4.4","description":"Build docs for HubSpot projects using Docco","directories":{},"dependencies":{"q":"~0.9.6","glob":"~3.1.17","jade":"~0.28.2","temp":"~0.6.0","async":"~0.2.9","colors":"~0.6.0-1","marked":"~0.2.9","mkdirp":"~0.3.5","watchr":"~2.4.3","libyaml":"~0.2.1","commander":"~1.1.1","underscore":"~1.4.3","graceful-fs":"~2.0.1","highlight.js":"~7.3.0","coffee-script":"~1.4.0"},"devDependencies":{"request":"~2.27.0","liveconfig":"~0.1.9"}},"0.14.1":{"name":"hsdoc","version":"0.14.1","keywords":["documentation"],"author":{"name":"Zack Bloom","email":"zbloom@hubspot.com"},"license":"MIT","_id":"hsdoc@0.14.1","maintainers":[{"name":"hs","email":"zbloom@hubspot.com"}],"bin":{"hsdoc":"run.js"},"dist":{"shasum":"34ebea537b11f6a495a799a74a5de9f960c982bf","tarball":"https://registry.npmjs.org/hsdoc/-/hsdoc-0.14.1.tgz","integrity":"sha512-+aVDON3Kuo35hn/2CwvDJtRBlacMUTRDpEo+QwAP+ucQUCV8QPafm223lt9neHPkqQZElstC/LdiHgEId+uVHQ==","signatures":[{"sig":"MEQCIB/9gQ1ke/pHZABFYrsryizBUKK6oSCRjgXmI5W1V1m7AiA2NCfSqQW4RG2UHVnQFB84f52dTLSnxtPZ4qYDaSP+GQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}]},"main":"documenter.coffee","_from":".","_shasum":"34ebea537b11f6a495a799a74a5de9f960c982bf","gitHead":"dfc47c5c2eee106ac0246e0480b49da06b039c90","scripts":{},"_npmUser":{"name":"hs","email":"dev@hubspot.com"},"_npmVersion":"2.14.3","description":"Build docs for HubSpot projects using Docco","directories":{},"_nodeVersion":"4.0.0","dependencies":{"q":"^1.4.1","glob":"^5.0.10","jade":"^1.10.0","temp":"^0.8.1","async":"^1.2.0","chalk":"^1.0.0","marked":"^0.3.3","mkdirp":"^0.5.1","watchr":"^2.4.13","js-yaml":"^3.3.1","commander":"^2.8.1","underscore":"^1.8.3","graceful-fs":"^3.0.8","highlight.js":"^8.6.0","coffee-script":"^1.9.0"},"devDependencies":{"request":"^2.57.0","liveconfig":"^0.2.5"}},"0.14.2":{"name":"hsdoc","version":"0.14.2","keywords":["documentation"],"author":{"name":"Zack Bloom","email":"zbloom@hubspot.com"},"license":"MIT","_id":"hsdoc@0.14.2","maintainers":[{"name":"hs","email":"zbloom@hubspot.com"}],"bin":{"hsdoc":"run.js"},"dist":{"shasum":"fb601faa024147def706e9d6c441f607f769df36","tarball":"https://registry.npmjs.org/hsdoc/-/hsdoc-0.14.2.tgz","integrity":"sha512-ll3stZZzp0zHNuRZg2nY5OFPoDaoh+Mf2Coopg8UJvVJUWEOCkT0S5kj7ppYOPS48TCp5tiO35DnTzHwdGqutA==","signatures":[{"sig":"MEUCIAqEUECplVqMRsJ2mGdabsmJrcnKxsVr2KVd9TJoPxG2AiEA9tN/V5LASARRxzXQo3fCGKBzz6bQziyBPWQ0VXl0LBI=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}]},"main":"documenter.coffee","_from":".","_shasum":"fb601faa024147def706e9d6c441f607f769df36","gitHead":"71ae63c8f2a9744ab50aa276a15c792bca2ee646","scripts":{},"_npmUser":{"name":"hs","email":"devteam@hubspot.com"},"_npmVersion":"2.14.7","description":"Build docs for HubSpot projects using Docco","directories":{},"_nodeVersion":"4.2.1","dependencies":{"q":"^1.4.1","glob":"^5.0.10","jade":"^1.10.0","temp":"^0.8.1","async":"^1.2.0","chalk":"^1.0.0","marked":"^0.3.3","mkdirp":"^0.5.1","watchr":"^2.4.13","js-yaml":"^3.3.1","commander":"^2.8.1","underscore":"^1.8.3","graceful-fs":"^3.0.8","highlight.js":"^8.6.0","coffee-script":"^1.9.0"},"devDependencies":{"request":"^2.57.0","liveconfig":"git+ssh://git@git.hubteam.com:HubSpot/LiveConfigNode.git#v0.2.6"},"_npmOperationalInternal":{"tmp":"tmp/hsdoc-0.14.2.tgz_1503803110514_0.2279223818331957","host":"s3://npm-registry-packages"}}},"time":{"created":"2014-04-21T20:17:09.115Z","modified":"2026-08-27T16:32:06.393Z","0.13.8":"2014-04-21T20:17:09.115Z","0.13.9":"2014-04-24T19:56:16.794Z","0.14.1":"2015-09-18T14:56:30.138Z","0.14.2":"2017-08-27T03:05:11.743Z"},"author":{"name":"Zack Bloom","email":"zbloom@hubspot.com"},"license":"MIT","keywords":["documentation"],"description":"Build docs for HubSpot projects using Docco","maintainers":[{"email":"devteam@hubspot.com","name":"rberdeen-hubspot"},{"email":"ryan@ryanberdeen.com","name":"also"},{"email":"kevin@kj800x.com","name":"kj800x"},{"email":"hilker.j@gmail.com","name":"jhilker"},{"email":"service-ccs+npmjs.com@hubspot.com","name":"service-ccs"},{"email":"henry.dineen@gmail.com","name":"henryqdineen"},{"email":"akuhl@hubspot.com","name":"akuhl-hubspot"},{"email":"benjaminjbaum@gmail.com","name":"bent0b0x"}],"readme":"HSDoc\n=====\n\n[Take a Look](https://git.hubteam.com/pages/HubSpot/HSDoc)\n\nInstallation\n------------\n\n    npm install -g hsdoc\n\nUsage\n-----\n\nIn the root directory of your project:\n\n    hsdoc -a\n\nThis will give you a gh-pages branch with your documentation in it, and push it to github.  Just\nrun it again whenever you make changes.\n\nFiles\n-----\n\nHsDoc looks for three things: source files, examples, and an intro.\n\nThe source files get ran through Docco, and (by default) spat out into `docs/build/source`.\nUse the `-s` parameter (or `source` in your .hsdoc file) to control what glob pattern is used to find your files.\n\nThe examples should be (by default) in `docs/examples`.  The general structure is:\n\n    docs/examples/1-My Awesome Example.md\n    docs/examples/2-Harder Stuff.md\n\nThe numbers are used to preserve an order when showing them in the index page, and are optional.\n\nYour intro is either your `README.md`, or `docs/intro.md`.  It's used to provide a project summary, and on the project's index page.\nYour intro will also be used in the forthcoming bestjs style guide.\n\nIndex Page\n----------\n\nHsDoc builds you an index page at index.html with the full (compiled) content of your intro, and a listing of your source files\nand examples.  If you already have an index page of some sort, you might want to use the `--index` option to have HsDocs index file\nplaced somewhere else.\n\nOptions\n-------\n\nSee `hsdoc --help` for options.  You can also add a .hsdoc yaml file to the root of your\nproject to provide configuration.  See hapijs for an example.\n\n","readmeFilename":"README.md"}