Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/docpad-archive/docpad-plugin-nativecomments

Adds support for native comments to DocPad
https://github.com/docpad-archive/docpad-plugin-nativecomments

docpad-plugin unsupported

Last synced: 2 days ago
JSON representation

Adds support for native comments to DocPad

Host: GitHub
URL: https://github.com/docpad-archive/docpad-plugin-nativecomments
Owner: docpad-archive
License: other
Created: 2013-01-02T08:53:25.000Z (almost 12 years ago)
Default Branch: master
Last Pushed: 2015-06-11T11:48:48.000Z (over 9 years ago)
Last Synced: 2024-09-18T14:11:00.950Z (about 2 months ago)
Topics: docpad-plugin, unsupported
Language: CoffeeScript
Homepage:
Size: 241 KB
Stars: 8
Watchers: 18
Forks: 3
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # Native Comments Plugin for [DocPad](https://docpad.org)

[![Build Status](https://img.shields.io/travis/docpad/docpad-plugin-nativecomments/master.svg)](http://travis-ci.org/docpad/docpad-plugin-nativecomments "Check this project's build status on TravisCI")

[![NPM version](https://img.shields.io/npm/v/docpad-plugin-nativecomments.svg)](https://npmjs.org/package/docpad-plugin-nativecomments "View this project on NPM")

[![NPM downloads](https://img.shields.io/npm/dm/docpad-plugin-nativecomments.svg)](https://npmjs.org/package/docpad-plugin-nativecomments "View this project on NPM")

[![Dependency Status](https://img.shields.io/david/docpad/docpad-plugin-nativecomments.svg)](https://david-dm.org/docpad/docpad-plugin-nativecomments)

[![Dev Dependency Status](https://img.shields.io/david/dev/docpad/docpad-plugin-nativecomments.svg)](https://david-dm.org/docpad/docpad-plugin-nativecomments#info=devDependencies)


[![Gratipay donate button](https://img.shields.io/gratipay/docpad.svg)](https://www.gratipay.com/docpad/ "Donate weekly to this project using Gratipay")

[![Flattr donate button](https://img.shields.io/badge/flattr-donate-yellow.svg)](http://flattr.com/thing/344188/balupton-on-Flattr "Donate monthly to this project using Flattr")

[![PayPal donate button](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=QB8GQPZAH84N6 "Donate once-off to this project using Paypal")

[![BitCoin donate button](https://img.shields.io/badge/bitcoin-donate-yellow.svg)](https://coinbase.com/checkouts/9ef59f5479eec1d97d63382c9ebcb93a "Donate once-off to this project using BitCoin")

[![Wishlist browse button](https://img.shields.io/badge/wishlist-donate-yellow.svg)](http://amzn.com/w/2F8TXKSNAFG4V "Buy an item on our wishlist for us")

Adds support for native comments to [DocPad](https://docpad.org)

## 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:

	``` erb

	---

	layout: default

	---

	

	    
<%= @document.title %>

	    <%= @document.author %>

	    <%= @getDatabase().get(@document.for)?.get('title') %>

	    

	        <%- @content %>

	    

	

	```

## 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.](https://github.com/docpad/docpad-plugin-nativecomments/blob/master/HISTORY.md#files)

## Contribute

[Discover how you can contribute by heading on over to the `CONTRIBUTING.md` file.](https://github.com/docpad/docpad-plugin-nativecomments/blob/master/CONTRIBUTING.md#files)

## Backers

### Maintainers

These amazing people are maintaining this project:

- Benjamin Lupton  (https://github.com/balupton)


### Sponsors

No sponsors yet! Will you be the first?

[![Gratipay donate button](https://img.shields.io/gratipay/docpad.svg)](https://www.gratipay.com/docpad/ "Donate weekly to this project using Gratipay")

[![Flattr donate button](https://img.shields.io/badge/flattr-donate-yellow.svg)](http://flattr.com/thing/344188/balupton-on-Flattr "Donate monthly to this project using Flattr")

[![PayPal donate button](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=QB8GQPZAH84N6 "Donate once-off to this project using Paypal")

[![BitCoin donate button](https://img.shields.io/badge/bitcoin-donate-yellow.svg)](https://coinbase.com/checkouts/9ef59f5479eec1d97d63382c9ebcb93a "Donate once-off to this project using BitCoin")

[![Wishlist browse button](https://img.shields.io/badge/wishlist-donate-yellow.svg)](http://amzn.com/w/2F8TXKSNAFG4V "Buy an item on our wishlist for us")

### Contributors

These amazing people have contributed code to this project:

- [Benjamin Lupton](https://github.com/balupton)  — [view contributions](https://github.com/docpad/docpad-plugin-nativecomments/commits?author=balupton)


[Become a contributor!](https://github.com/docpad/docpad-plugin-nativecomments/blob/master/CONTRIBUTING.md#files)

## License

Unless stated otherwise all works are:

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

and licensed under:

- The incredibly [permissive](http://en.wikipedia.org/wiki/Permissive_free_software_licence) [MIT License](http://opensource.org/licenses/mit-license.php)