docpad-plugin-tags

Create tag pages within DocPad

npm install docpad-plugin-tags
49 downloads in the last week
112 downloads in the last month

Tags Plugin for DocPad

Build Status NPM version Gittip donate button Flattr donate button PayPayl donate button

Create tag pages within DocPad

Install

docpad install tags

Configuration

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', @) %>
            """
    )

You can find a great example of this customisation within the syte skeleton which combines the tags plugin with the partials plugin as well as the tumblr plugin and paged plugin.

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>

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?

Gittip donate button Flattr donate button PayPayl donate button

Contributors

These amazing people have contributed code to this project:

Become a contributor!

License

Licensed under the incredibly permissive MIT license

Copyright © 2013+ Bevry Pty Ltd us@bevry.me (http://bevry.me)

npm loves you