/handlebars-helper-autolink

{{autolink}} handlebars helper. Generate relative links from the "current page" to other dest pages.

Primary LanguageJavaScriptMIT LicenseMIT

{{autolink}} NPM version

Generate relative links from the "current page" to other dest pages.

Installation

Use npm to install the package: npm i handlebars-helper-autolink.

Register the helper

In your project's Gruntfile, to register the helper add handlebars-helper-autolink to the helpers property in the Assemble task or target options:

grunt.initConfig({
  assemble: {
    options: {
      // the 'handlebars-helper-autolink' npm module must also be listed in
      // devDependencies for assemble to automatically resolve the helper
      helpers: ['handlebars-helper-autolink', 'foo/*.js']
    },
    files: {
      'dist/': ['src/templates/*.hbs']
    }
  }
});

Alternatively, you can avoid defining the helper in the Assemble task options by adding module to both the devDependencies and keywords in your project's package.json.

{
  "name": "foo",
  "version": "0.1.0",
  "devDependencies": {
    "handlebars-helper-autolink": "*"
  },
  "keywords": [
    "handlebars-helper-autolink"
  ]
}

Usage

With the helper registered, you may now begin using it in your templates.

In a "page"

{{#each pages}}
  <a href="{{autolink}}">{{data.title}}</a>
{{/each}}

In a "layout"

{{#each pages}}
  <a href="{{autolink}}">{{../title}}</a>
{{/each}}

Author

Jon Schlinkert

License and Copyright

Licensed under the MIT License Copyright (c) Jon Schlinkert, contributors.