Adds support for related documents to DocPad
CoffeeScript HTML
Latest commit 7e1d46a Mar 5, 2015 @balupton balupton updated base files

README.md

Related Plugin for DocPad

Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
Gratipay donate button Flattr donate button PayPayl donate button BitCoin donate button Wishlist browse button

Adds support for related documents to DocPad

Install

docpad install related

Usage

Add a tags array to your document meta (in the header). Example :

documents/dog.html.md

---
title: My blog post about dogs
tags:
  - animal
---

documents/cat.html.md

---
title: My blog post about cats
tags:
  - animal
---

Both posts will be related through the animal tag. In the template.

To output the related documents, use the getRelatedDocuments(document?) collection helper like so using eco.

<% for document in @getRelatedDocuments(): %>
    <a href="<%= document.url %>"><%= document.title %></a><br/>
<% end %>

Configuration

  • parentCollectionName defaults to html - use to specify the collection we should scan for related documents

History

Discover the change history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

No sponsors yet! Will you be the first?

Gratipay donate button Flattr donate button PayPayl donate button BitCoin donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

Become a contributor!

License

Unless stated otherwise all works are:

and licensed under: