docpad-plugin-navlinks

Docpad plugin which adds the ability to generate a navigation bar for documents with links to the next and previous document of a specified collection

NavLinks Plugin for DocPad


Adds the ability to generate a navigation bar for documents with links to the next and previous document of a specified collection for DocPad.

Node

  • Use: require('docpad-plugin-navlinks')
  • Install: npm install --save docpad-plugin-navlinks

The purpose of this plugin is to generate a navigation bar for documents with links to the next and previous document of a specified collection. Useful especially for posts.

Edit the docpad.coffee configuration file.

Identify one o more collections you want add navbar links in the

  collections:
    pages: (database) ->
      database.findAllLive({pageOrder: $exists: true}[pageOrder:1,title:1])
    posts: (database) ->
      database.findAllLive({layout:$has:'post'}[date:-1])

Define collections you want to enable navbar links. You may also specifies collection sorting (-1 for reverse order).

  # Plugins configurations 
  plugins:
    navlinks:
      collections:
        posts: -1
        pages: 1

In the eco template (i.e. post.html.eco) add:

    <%- @getNavLinks() %>

You may style the navlinks usign the following css classes:

.navlinks {}
 
.navlinks-prev {
    float: left;
}
 
.navlinks-next {
    float: right;
}

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

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

These amazing people are maintaining this project:

No sponsors yet! Will you be the first?

These amazing people have contributed code to this project:

Become a contributor!

Licensed under the incredibly permissive MIT license

Copyright © Luca Corbo lu.corbo@gmail.com (http://lucor.github.io)