helper-codelinks v0.1.2

helper-codelinks

Generate a list of links that take you to the first line of code for each method in a given directory.

Install with npm

npm i helper-codelinks --save

Usage

Add a verbfile.js to your project with the following:

var verb = require('verb');

// register the helper
verb.helper('codelinks', require('helper-codelinks'));

// add a task to build your docs
verb.task('default', function () {
  return verb.src('my-documentation.md')
    .pipe(verb.dest('docs/'));
});

In your .verb.md file:

{%= codelinks('lib/', {filter: '!**/foo.js'}) %}

Results in markdown like this:

+ **[one](fixtures/one.js)**
  - [.a](fixtures/one.js#L7)
  - [.b](fixtures/one.js#L13)
  - [.c](fixtures/one.js#L19)
+ **[two](fixtures/two.js)**
  - [.c](fixtures/two.js#L7)
  - [.d](fixtures/two.js#L13)
  - [.e](fixtures/two.js#L19)

_(Code links generated by [verb] using the [api-toc] helper)_

Which renders to a list of links that looks like this:

• one
  • .a
  • .b
  • .c
• two
  • .c
  • .d
  • .e

(Code links generated by verb using the api-toc helper)

See the example verbfile.js.

Related projects

• template-helpers: Generic JavaScript helpers that can be used with any template engine. Handlebars, Lo-Dash, Underscore, or any engine that supports helper functions.
• 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.
• api-toc: Pass a dirname, get a markdown-formatted Table of Contents for your API.

Running tests

Install dev dependencies:

npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright (c) 2015 Jon Schlinkert
Released under the MIT license

This file was generated by verb-cli on April 19, 2015.