https://github.com/docpad/docpad-plugin-related

Adds support for related documents to DocPad
https://github.com/docpad/docpad-plugin-related

docpad-plugin

Last synced: 2 months ago
JSON representation

Adds support for related documents to DocPad

• Host: GitHub
• URL: https://github.com/docpad/docpad-plugin-related
• Owner: docpad
• License: other
• Created: 2012-10-17T11:40:39.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2023-12-31T10:16:14.000Z (about 1 year ago)
• Last Synced: 2024-09-23T01:44:48.466Z (4 months ago)
• Topics: docpad-plugin
• Language: CoffeeScript
• Homepage:
• Size: 200 KB
• Stars: 10
• Watchers: 17
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        


Related Plugin for DocPad

































Adds support for related documents to DocPad

## 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](http://docpad.org/p/eco).

```

<% for document in @getRelatedDocuments(): %>

	<%= document.title %>


<% end %>

```

## Configuration

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

Install


Install this DocPad plugin by entering docpad install related into your terminal.

History


Discover the release 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:



Benjamin Lupton — view contributions



Sponsors


No sponsors yet! Will you be the first?



















Contributors


These amazing people have contributed code to this project:





Benjamin Lupton — view contributions





Bruno Heridet — view contributions





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

License


Unless stated otherwise all works are:

Copyright © 2012+ Bevry Pty Ltd



and licensed under:

MIT License