docpad-plugin-nativecomments

Adds support for native comments to DocPad

npm install docpad-plugin-nativecomments
2 downloads in the last day
19 downloads in the last week
68 downloads in the last month

Native Comments Plugin for DocPad

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

Adds support for native comments to DocPad

Install

  1. Install the Plugin

    docpad install nativecomments
    
  2. Output the comment form and listing. You may have to change your document's extension (that you place this snippet inside) to my-document.html.eco.eco to ensure the inner eco logic within the block is rendered correctly.

    <%- @getCommentsBlock() %>
    
  3. Create a comment layout that contains something like:

    ``` erb

---
layout: default
---

<article class="comment">
    <h1 class="comment-title"><%= @document.title %></h1>
    <span class="comment-author"><%= @document.author %></span>
    <a href="<%= @getDatabase().get(@document.for)?.get('url') %>" class="comment-for"><%= @getDatabase().get(@document.for)?.get('title') %></a>
    <div class="comment-body">
        <%- @content %>
    </div>
</article>
```

Configure

Some configuration options are available. Check out src/nativecomments.plugin.coffee for them.

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 BitCoin 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