Related pages Assemble plugin.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
example/1
lib
.gitignore
Gruntfile.js
LICENSE-MIT
README.md
package.json

README.md

assemble-related-pages

NPM version NPM dependencies

An Assemble plugin for generating lists of related pages.

Current implementation uses tags, and defines related pages as those that share at least one tag.

Usage

First, setup a project with Grunt and Assemble.

Then install the plugin:

npm install --save-dev assemble-related-pages

Add the plugin to your Grunt assemble config:

assemble: {
  options: {
    plugins: [ 'assemble-related-pages' ]
  },
  pages: {
    src: ['docs/*.hbs'],
    dest: './'
  }
},

Use tags in your pages.

Then, anywhere you like, add something like the following to your layouts and/or pages:

  {{#each page.related}}
    <li>
      <a href="{{relative ../page.dest this.dest}}">{{this.data.title}}</a>
    </li>
  {{/each}}

Examples

See example/1/src and the assemble:example_1 task in Gruntfile.js.