Adds support for native comments to DocPad
CoffeeScript HTML
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
test
.editorconfig
.gitignore
.npmignore
.travis.yml
CONTRIBUTING.md
Cakefile
HISTORY.md
LICENSE.md
README.md
coffeelint.json
package.json

README.md

Native Comments Plugin for DocPad

Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
Gratipay donate button Flattr donate button PayPal donate button BitCoin donate button Wishlist browse button

Adds support for native comments to DocPad

Install

  1. Install the Plugin
docpad install nativecomments
  1. 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() %>
  1. Create a comment layout that contains something like:

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

Gratipay donate button Flattr donate button PayPal donate button BitCoin donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

Become a contributor!

License

Unless stated otherwise all works are:

and licensed under: