{"_id":"api-toc","_rev":"13-990e416077de366864410486b8c211bf","name":"api-toc","description":"Pass a dirname, get a markdown-formatted Table of Contents for your API.","dist-tags":{"latest":"0.3.2"},"versions":{"0.1.0":{"name":"api-toc","description":"Create a markdown-formatted Table of Contents for your API.","version":"0.1.0","homepage":"https://github.com/jonschlinkert/api-toc","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/api-toc.git"},"bugs":{"url":"https://github.com/jonschlinkert/api-toc/issues"},"license":{"type":"MIT","url":"https://github.com/jonschlinkert/api-toc/blob/master/LICENSE"},"files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"code-context":"^0.5.0","export-files":"^1.3.0","markdown-utils":"^0.4.0","relative":"^2.0.0"},"devDependencies":{"mocha":"^2.2.1","should":"*"},"_id":"api-toc@0.1.0","_shasum":"4910ff6bd374d12b33457c5234d1160f4c211a31","_from":".","_npmVersion":"2.5.1","_nodeVersion":"0.12.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"4910ff6bd374d12b33457c5234d1160f4c211a31","tarball":"https://registry.npmjs.org/api-toc/-/api-toc-0.1.0.tgz","integrity":"sha512-ogeQuZE+qa9mZBdxO0OUXM7Ti9giVEUb7XSAO+77EXjr3WUNDBqC3H7ByjMHYa6RlxLQ59xfVm5qCC1Vlmc4wg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFXeP54wjsmDkQZ/wEK4shdd0HFhhRB5wtTe+S1OkX3RAiEArsy0AhWNk4zlbvCiw5PlOz+tcdiqg43+f7a+UWbSqiA="}]}},"0.1.1":{"name":"api-toc","description":"Pass a dirname, get a markdown-formatted Table of Contents for your API.","version":"0.1.1","homepage":"https://github.com/jonschlinkert/api-toc","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/api-toc.git"},"bugs":{"url":"https://github.com/jonschlinkert/api-toc/issues"},"license":{"type":"MIT","url":"https://github.com/jonschlinkert/api-toc/blob/master/LICENSE"},"files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"code-context":"^0.5.0","export-files":"^1.3.0","markdown-utils":"^0.4.0","relative":"^2.0.0"},"devDependencies":{"mocha":"^2.2.1","should":"*"},"gitHead":"a43413a325d35670f7eb013f85c489ece7eaa829","_id":"api-toc@0.1.1","_shasum":"1cce45cd8036d9ee2df4ccd3e5da1db544c80966","_from":".","_npmVersion":"2.5.1","_nodeVersion":"0.12.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"1cce45cd8036d9ee2df4ccd3e5da1db544c80966","tarball":"https://registry.npmjs.org/api-toc/-/api-toc-0.1.1.tgz","integrity":"sha512-qXPcf6fPzIL1UfGekp3h0sxjFqJUOhDkrkXUwYh5EECsZibAgX4qkTE0EViVVeTJYlHFHy/N2d334gjtVYSJvQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCVlsYrX+4i9gOQMkqAJ0rL0P7DG9YwX5yEb4MmBlGNjgIhAPqT+90E7o96KzLDjnekOAPluY7NASO8DNg05FWZMERu"}]}},"0.1.2":{"name":"api-toc","description":"Pass a dirname, get a markdown-formatted Table of Contents for your API.","version":"0.1.2","homepage":"https://github.com/jonschlinkert/api-toc","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/api-toc.git"},"bugs":{"url":"https://github.com/jonschlinkert/api-toc/issues"},"license":{"type":"MIT","url":"https://github.com/jonschlinkert/api-toc/blob/master/LICENSE"},"files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"code-context":"^0.5.0","export-files":"^1.3.0","markdown-utils":"^0.4.0","relative":"^2.0.0"},"devDependencies":{"mocha":"^2.2.1","should":"*"},"gitHead":"0884641303de8465377348694032464d1dccca8f","_id":"api-toc@0.1.2","_shasum":"7451f38b82b331b0c758d8046ce2142073231ecf","_from":".","_npmVersion":"2.5.1","_nodeVersion":"0.12.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"7451f38b82b331b0c758d8046ce2142073231ecf","tarball":"https://registry.npmjs.org/api-toc/-/api-toc-0.1.2.tgz","integrity":"sha512-m0c9bRCU0RQ+ct56x9IWURKoV8c+tBkFVXyj6kzZVoJokIy08Ekp54s1GUuHw+Ol23pwoFQEQ6G+GjQXehCazw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIE1lin/07NOeypYVE4bQkJhhgPVQasVYCzq5mXiyaFYEAiBeQsUb3q9rzJnHxPXy+rAyt3Ct+d2txLOSUdLz6OaKrw=="}]}},"0.2.0":{"name":"api-toc","description":"Pass a dirname, get a markdown-formatted Table of Contents for your API.","version":"0.2.0","homepage":"https://github.com/jonschlinkert/api-toc","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/api-toc.git"},"bugs":{"url":"https://github.com/jonschlinkert/api-toc/issues"},"license":{"type":"MIT","url":"https://github.com/jonschlinkert/api-toc/blob/master/LICENSE"},"files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"code-context":"^0.5.0","export-files":"^1.3.0","markdown-utils":"^0.4.0","relative":"^2.0.0"},"devDependencies":{"mocha":"^2.2.1","should":"*"},"gitHead":"0553bdc33294b2590a7ca6ee2b81173da9f48138","_id":"api-toc@0.2.0","_shasum":"d627ea52bf7ea7f4340723983b48bb3950be8c00","_from":".","_npmVersion":"2.5.1","_nodeVersion":"0.12.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"d627ea52bf7ea7f4340723983b48bb3950be8c00","tarball":"https://registry.npmjs.org/api-toc/-/api-toc-0.2.0.tgz","integrity":"sha512-wQAQVafUvqYtJfZ0vn2vOqzHYGdBYRlIiumMHlW6oWuoMGmkH0uvlQpUb4D590I4stQf0B3NMpg74cpDWwqrzA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFP8wYgeAqixNEDFcoFFhcRdP35Mul4EOxQH/RvQ0HsgAiEA+vWu9m7A9HQkC/ZMckWxr12KaSf2SBM0yOmDt5OvM6w="}]}},"0.3.0":{"name":"api-toc","description":"Pass a dirname, get a markdown-formatted Table of Contents for your API.","version":"0.3.0","homepage":"https://github.com/jonschlinkert/api-toc","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/api-toc.git"},"bugs":{"url":"https://github.com/jonschlinkert/api-toc/issues"},"license":{"type":"MIT","url":"https://github.com/jonschlinkert/api-toc/blob/master/LICENSE"},"files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"array-pull":"^0.2.0","code-context":"^0.5.0","export-files":"^1.3.0","filter-object":"^1.1.2","markdown-utils":"^0.4.0","mixin-deep":"^1.0.1","relative":"^2.0.0"},"devDependencies":{"mocha":"^2.2.1","object.omit":"^1.1.0","should":"*"},"gitHead":"18e81bd1dc0a0ce0743019444bd9d279e16d3111","_id":"api-toc@0.3.0","_shasum":"028eb20f2420ad87f1180a42c368a6a8fc3790aa","_from":".","_npmVersion":"2.5.1","_nodeVersion":"0.12.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"028eb20f2420ad87f1180a42c368a6a8fc3790aa","tarball":"https://registry.npmjs.org/api-toc/-/api-toc-0.3.0.tgz","integrity":"sha512-5Qnuou3M+xBElSa28uhbE3HoJykiDF3sihMc2A2jQr932nIwN1PzFPcyDeJ74YeHGf/6fhY+3YEKsK1MQr5LEg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEnJt+mQDdbjouPOOgM12WcoYBJqEIiPHq6PT+gGli0WAiBGnEyBoMmEGup7zgsbKodwbOs9TwId/SXVxDmSnOkEoA=="}]}},"0.3.1":{"name":"api-toc","description":"Pass a dirname, get a markdown-formatted Table of Contents for your API.","version":"0.3.1","homepage":"https://github.com/jonschlinkert/api-toc","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/jonschlinkert/api-toc.git"},"bugs":{"url":"https://github.com/jonschlinkert/api-toc/issues"},"license":{"type":"MIT","url":"https://github.com/jonschlinkert/api-toc/blob/master/LICENSE"},"files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"code-context":"^0.5.0","filter-object":"^1.1.2","markdown-utils":"^0.4.0","mixin-deep":"^1.0.1","relative":"^2.0.0"},"devDependencies":{"mocha":"^2.2.1","should":"*"},"gitHead":"304e06d76141e0a72b54724ca29b2ec494d5008b","_id":"api-toc@0.3.1","_shasum":"dac4ba2edda69da0b533dd4f56ef2c2f88d5f27c","_from":".","_npmVersion":"2.5.1","_nodeVersion":"0.12.0","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"dac4ba2edda69da0b533dd4f56ef2c2f88d5f27c","tarball":"https://registry.npmjs.org/api-toc/-/api-toc-0.3.1.tgz","integrity":"sha512-L4eUuCmk9wQn/fJVlR5yFJwSKfDHYKKXrgaosile69pA3fEHnMQwWmB72zED6DkFd3pCDIJ26FLN9LdfvrjCTQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCujvxU9tTEtSBizW6eV+eionOYOo56bg1ObPhReGp3dQIhAJImEChAexTwK3boyr6LnlFGyFcVUj2WOUUvj99b4cR5"}]}},"0.3.2":{"name":"api-toc","description":"Pass a dirname, get a markdown-formatted Table of Contents for your API.","version":"0.3.2","homepage":"https://github.com/jonschlinkert/api-toc","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git+https://github.com/jonschlinkert/api-toc.git"},"bugs":{"url":"https://github.com/jonschlinkert/api-toc/issues"},"license":"MIT","files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"dependencies":{"code-context":"^0.5.2","filter-object":"^2.0.0","markdown-utils":"^0.7.0","mixin-deep":"^1.1.1","relative":"^3.0.1"},"devDependencies":{"mocha":"^2.2.1","should":"*"},"gitHead":"304e06d76141e0a72b54724ca29b2ec494d5008b","_id":"api-toc@0.3.2","_shasum":"5e73e7aa4b8dac74a79d9e616be914a91de047fa","_from":".","_npmVersion":"2.10.1","_nodeVersion":"0.12.4","_npmUser":{"name":"jonschlinkert","email":"github@sellside.com"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"dist":{"shasum":"5e73e7aa4b8dac74a79d9e616be914a91de047fa","tarball":"https://registry.npmjs.org/api-toc/-/api-toc-0.3.2.tgz","integrity":"sha512-U7ayuzLh5G2/1iOGv95ie0TkSC1HqXz76kEhgku7zRWvjWRzgJHK3Tvl6f6paLqGN5pIu1ZslhT5JShJl4/2CA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDQIfs5++GAU+MyRH8wwdYpzc9kaMTU2kbtST9jgsfHRAiBKA1JJbnL0or6ucXQxdmp5rWgZ+XaE9xa0xdJj31rOdg=="}]}}},"readme":"# api-toc [![NPM version](https://badge.fury.io/js/api-toc.svg)](http://badge.fury.io/js/api-toc)  [![Build Status](https://travis-ci.org/jonschlinkert/api-toc.svg)](https://travis-ci.org/jonschlinkert/api-toc)\n\n> Pass a dirname, get a markdown-formatted Table of Contents for your API.\n\nCurrently this is pretty opinionated, but I may add a reduce or filter function to allow customizing the output. PR or suggestions welcome.\n\nInstall with [npm](https://www.npmjs.com/)\n\n```sh\n$ npm i api-toc --save\n```\n\n## Usage\n\n```js\nvar toc = require('api-toc');\n```\n\n**Example**\n\nUsing the pseudo-code in `fixtures/`:\n\n```js\ntoc('fixtures/');\n```\n\nResults in:\n\n* **[config](fixtures/config.js)**\n\n  - [.disable](fixtures/config.js#L10)\n  - [.enable](fixtures/config.js#L6)\n  - [.option](fixtures/config.js#L2)\n* **[storage](fixtures/storage.js)**\n\n  - [.extend](fixtures/storage.js#L10)\n  - [.get](fixtures/storage.js#L2)\n  - [.set](fixtures/storage.js#L6)\n* **[utils](fixtures/utils.js)**\n\n  - [.bar](fixtures/utils.js#L6)\n  - [.baz](fixtures/utils.js#L10)\n  - [.foo](fixtures/utils.js#L2)\n\nThe generated markdown looks like this:\n\n```markdown\n+ **[config](fixtures/config.js)**\n  - [.disable](fixtures/config.js#L10)\n  - [.enable](fixtures/config.js#L6)\n  - [.option](fixtures/config.js#L2)\n+ **[storage](fixtures/storage.js)**\n  - [.extend](fixtures/storage.js#L10)\n  - [.get](fixtures/storage.js#L2)\n  - [.set](fixtures/storage.js#L6)\n+ **[utils](fixtures/utils.js)**\n  - [.bar](fixtures/utils.js#L6)\n  - [.baz](fixtures/utils.js#L10)\n  - [.foo](fixtures/utils.js#L2)\n```\n\n## Related projects\n\n* [helper-apidocs](https://github.com/jonschlinkert/helper-apidocs): Template helper for automatically generating API docs from code comments. The sync version works with… [more](https://github.com/jonschlinkert/helper-apidocs)\n* [markdown-toc](https://github.com/jonschlinkert/markdown-toc): Generate a markdown TOC (table of contents) with Remarkable.\n\n## Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm i -d && npm test\n```\n\n## Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/api-toc/issues/new)\n\n## Author\n\n**Jon Schlinkert**\n\n+ [github/jonschlinkert](https://github.com/jonschlinkert)\n+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)\n\n## License\n\nCopyright © 2015 Jon Schlinkert\nReleased under the MIT license.\n\n***\n\n_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on August 01, 2015._","maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"time":{"modified":"2022-06-13T03:12:34.800Z","created":"2015-03-11T00:42:10.929Z","0.1.0":"2015-03-11T00:42:10.929Z","0.1.1":"2015-03-11T00:45:23.821Z","0.1.2":"2015-03-11T02:05:11.346Z","0.2.0":"2015-03-11T23:11:01.633Z","0.3.0":"2015-04-19T19:32:39.656Z","0.3.1":"2015-04-19T19:34:26.979Z","0.3.2":"2015-08-01T05:17:13.593Z"},"homepage":"https://github.com/jonschlinkert/api-toc","repository":{"type":"git","url":"git+https://github.com/jonschlinkert/api-toc.git"},"author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"bugs":{"url":"https://github.com/jonschlinkert/api-toc/issues"},"license":"MIT","readmeFilename":"README.md"}