Tags Plugin for DocPad
Create tag pages within DocPad
Install this DocPad plugin by entering
docpad install tags into your terminal.
Customising the Output
The default directory for where the imported documents will go inside is the
tags directory. You can customise this using the
relativeDirPath plugin configuration option.
The default extension for imported documents is
.json. You can customise this with the
extension plugin configuration option.
The default content for the imported documents is the serialised tag data as JSON data. You can can customise this with the
injectDocumentHelper plugin configuration option which is a function that takes in a single Document Model.
If you would like to render a partial for the imported document, add a layout, and change the extension, you can this with the following plugin configuration:
extension: '.html.eco' injectDocumentHelper: (document) -> document.setMeta( layout: 'default' data: """ <%- @partial('content/tag', @) %> """ )
Creating a File Listing
As imported documents are just like normal documents, you can also list them just as you would other documents. Here is an example of a
index.html.eco file that would output the titles and links to all the imported tag documents:
<h2>Tags:</h2> <ul><% for file in @getFilesAtPath('tags/').toJSON(): %> <li> <a href="<%= file.url %>"><%= file.title %></a> </li> <% end %></ul>
These amazing people are maintaining this project:
No sponsors yet! Will you be the first?
These amazing people have contributed code to this project:
Unless stated otherwise all works are:
- Copyright © 2013+ Bevry Pty Ltd
and licensed under: