Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    docpad-plugin-navlinkspublic

    NavLinks Plugin for DocPad

    Build Status NPM version Dependency Status Development Dependency Status

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

    Install

    Node

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

    Usage

    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.

    Setup

    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;
    }

    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?

    Contributors

    These amazing people have contributed code to this project:

    Become a contributor!

    License

    Licensed under the incredibly permissive MIT license

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

    install

    npm i docpad-plugin-navlinks

    Downloadsweekly downloads

    7

    version

    2.0.4

    license

    MIT

    repository

    github.com

    last publish

    collaborators

    • avatar