{"_id":"helper-codelinks","_rev":"94741","name":"helper-codelinks","description":"Generate a list of links that take you to the first line of code for each method in a given directory.","dist-tags":{"latest":"0.1.2"},"maintainers":[{"name":"jonschlinkert","email":"github@sellside.com"}],"time":{"modified":"2021-06-03T10:31:33.000Z","created":"2015-04-19T18:09:11.461Z","0.1.2":"2015-04-19T19:40:50.006Z","0.1.1":"2015-04-19T19:07:13.373Z","0.1.0":"2015-04-19T18:09:11.461Z"},"users":{},"author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/helpers/helper-codelinks.git"},"versions":{"0.1.2":{"name":"helper-codelinks","description":"Generate a list of links that take you to the first line of code for each method in a given directory.","version":"0.1.2","homepage":"https://github.com/helpers/helper-codelinks","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/helpers/helper-codelinks.git"},"bugs":{"url":"https://github.com/helpers/helper-codelinks/issues"},"license":{"type":"MIT","url":"https://github.com/helpers/helper-codelinks/blob/master/LICENSE"},"files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"devDependencies":{"mocha":"*","should":"*","verb":"^0.5.0"},"keywords":["api","assemble","assemblehelper","contents","docs","documentation","helper","helpers","table","template","templatehelper","toc","verb","verbhelper"],"dependencies":{"api-toc":"^0.3.1","mixin-deep":"^1.0.1"},"gitHead":"ad014e13e7f1fb816440e4042e256f3d6edcd4ec","_id":"helper-codelinks@0.1.2","_shasum":"8bfecb5af2e0373ae040aa2b700e89c0fa9d456f","_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":"8bfecb5af2e0373ae040aa2b700e89c0fa9d456f","size":2888,"noattachment":false,"key":"/helper-codelinks/-/helper-codelinks-0.1.2.tgz","tarball":"http://registry.cnpm.dingdandao.com/helper-codelinks/download/helper-codelinks-0.1.2.tgz"},"directories":{},"publish_time":1429472450006,"_cnpm_publish_time":1429472450006,"_hasShrinkwrap":false},"0.1.1":{"name":"helper-codelinks","description":"Generate a list of links that take you to the first line of code for each method in a given directory.","version":"0.1.1","homepage":"https://github.com/helpers/helper-codelinks","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/helpers/helper-codelinks.git"},"bugs":{"url":"https://github.com/helpers/helper-codelinks/issues"},"license":{"type":"MIT","url":"https://github.com/helpers/helper-codelinks/blob/master/LICENSE"},"files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"devDependencies":{"mocha":"*","should":"*","verb":"^0.5.0"},"keywords":["api","assemble","assemblehelper","contents","docs","documentation","helper","helpers","table","template","templatehelper","toc","verb","verbhelper"],"dependencies":{"api-toc":"^0.2.0"},"gitHead":"03e14f4df297d53290a3684140aa498b763e83b7","_id":"helper-codelinks@0.1.1","_shasum":"bd3aef9110d508ec5cd7955842d709ff5545e0a1","_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":"bd3aef9110d508ec5cd7955842d709ff5545e0a1","size":2861,"noattachment":false,"key":"/helper-codelinks/-/helper-codelinks-0.1.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/helper-codelinks/download/helper-codelinks-0.1.1.tgz"},"directories":{},"publish_time":1429470433373,"_cnpm_publish_time":1429470433373,"_hasShrinkwrap":false},"0.1.0":{"name":"helper-codelinks","description":"Generate a list of links to the first line of code for each method in a given directory.","version":"0.1.0","homepage":"https://github.com/helpers/helper-codelinks","author":{"name":"Jon Schlinkert","url":"https://github.com/jonschlinkert"},"repository":{"type":"git","url":"git://github.com/helpers/helper-codelinks.git"},"bugs":{"url":"https://github.com/helpers/helper-codelinks/issues"},"license":{"type":"MIT","url":"https://github.com/helpers/helper-codelinks/blob/master/LICENSE"},"files":["index.js"],"main":"index.js","engines":{"node":">=0.10.0"},"scripts":{"test":"mocha"},"devDependencies":{"mocha":"*","should":"*","verb":"^0.5.0"},"keywords":["api","assemble","assemblehelper","contents","docs","documentation","helper","helpers","table","template","templatehelper","toc","verb","verbhelper"],"dependencies":{"api-toc":"^0.2.0"},"gitHead":"543bb9c3f8e322a7860b959aef41ea8c74a3affd","_id":"helper-codelinks@0.1.0","_shasum":"802f7c6ef1f1ab77a4e81d376d338ef3530e5128","_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":"802f7c6ef1f1ab77a4e81d376d338ef3530e5128","size":2807,"noattachment":false,"key":"/helper-codelinks/-/helper-codelinks-0.1.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/helper-codelinks/download/helper-codelinks-0.1.0.tgz"},"directories":{},"publish_time":1429466951461,"_cnpm_publish_time":1429466951461,"_hasShrinkwrap":false}},"readme":"# helper-codelinks [![NPM version](https://badge.fury.io/js/helper-codelinks.svg)](http://badge.fury.io/js/helper-codelinks) [![Build Status](https://travis-ci.org/helpers/helper-codelinks.svg)](https://travis-ci.org/helpers/helper-codelinks) \n\n> Generate a list of links that take you to the first line of code for each method in a given directory.\n\n## Install with [npm](npmjs.org)\n\n```bash\nnpm i helper-codelinks --save\n```\n\n## Usage\n\nAdd a `verbfile.js` to your project with the following:\n\n```js\nvar verb = require('verb');\n\n// register the helper\nverb.helper('codelinks', require('helper-codelinks'));\n\n// add a task to build your docs\nverb.task('default', function () {\n return verb.src('my-documentation.md')\n .pipe(verb.dest('docs/'));\n});\n```\n\nIn your `.verb.md` file:\n\n```markdown\n{%= codelinks('lib/', {filter: '!**/foo.js'}) %}\n```\n\nResults in markdown like this:\n\n```markdown\n+ **[one](fixtures/one.js)**\n - [.a](fixtures/one.js#L7)\n - [.b](fixtures/one.js#L13)\n - [.c](fixtures/one.js#L19)\n+ **[two](fixtures/two.js)**\n - [.c](fixtures/two.js#L7)\n - [.d](fixtures/two.js#L13)\n - [.e](fixtures/two.js#L19)\n\n_(Code links generated by [verb] using the [api-toc] helper)_\n```\n\nWhich renders to a list of links that looks like this:\n\n+ **[one](fixtures/one.js)**\n - [.a](fixtures/one.js#L7)\n - [.b](fixtures/one.js#L13)\n - [.c](fixtures/one.js#L19)\n+ **[two](fixtures/two.js)**\n - [.c](fixtures/two.js#L7)\n - [.d](fixtures/two.js#L13)\n - [.e](fixtures/two.js#L19)\n\n_(Code links generated by [verb] using the [api-toc] helper)_\n\nSee the [example verbfile.js](./verbfile.js).\n\n## Related projects\n * [template-helpers](https://github.com/jonschlinkert/template-helpers): Generic JavaScript helpers that can be used with any template engine. Handlebars, Lo-Dash, Underscore, or any engine that supports helper functions.\n * [verb](https://github.com/assemble/verb): Verb makes it dead simple to generate markdown documentation, using simple templates, with zero configuration required. A project without documentation is like a project that doesn't exist.\n * [api-toc](https://github.com/jonschlinkert/api-toc): Pass a dirname, get a markdown-formatted Table of Contents for your API. \n\n## Running tests\nInstall dev dependencies:\n\n```bash\nnpm i -d && npm test\n```\n\n## Contributing\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/helpers/helper-codelinks/issues)\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\nCopyright (c) 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 April 19, 2015._\n\n\n\n\n[api-toc]: https://github.com/jonschlinkert/api-toc\n[verb]: https://github.com/assemble/verb\n[template]: https://github.com/jonschlinkert/template","_attachments":{},"homepage":"https://github.com/helpers/helper-codelinks","bugs":{"url":"https://github.com/helpers/helper-codelinks/issues"},"license":{"type":"MIT","url":"https://github.com/helpers/helper-codelinks/blob/master/LICENSE"}}