Metadata-Version: 2.1
Name: lektor-disqus-comments
Version: 0.4.1
Summary: Lektor plugin to add Disqus comments to a website.
Home-page: http://github.com/lektor/lektor-disqus-comments
Author: Armin Ronacher
Author-email: armin.ronacher@active-4.com
License: BSD
Keywords: Lektor plugin static-site blog Disqus comments
Platform: UNKNOWN
Classifier: Environment :: Plugins
Classifier: Environment :: Web Environment
Classifier: Framework :: Lektor
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Description-Content-Type: text/markdown

# lektor-disqus-comments

This plugin adds support for Disqus comments to Lektor.  Once the plugin is
enabled a `render_disqus_comments` function which can render a disqus comment
box.

## Enabling the Plugin

To enable the plugin add this to your project file:

```shell
$ lektor plugins add lektor-disqus-comments
```

## Configuring the Plugin

The plugin has a config file that is needed to inform it about your
website.  Just create a file named `disqus-comments.ini` into your
`configs/` folder and configure the `shortname` key with the name of
your disqus community:

```ini
shortname = YOUR_SHORTNAME
```

## In Templates

Now you can add a discussion box to any of your templates by just using
the `render_disqus_comments` function.  Just calling it is enough to
get the comment box:

```html
<div class="comments">{{ render_disqus_comments() }}</div>
```

Optionally the function accepts a few arguemnts:

* `identifier` and `url` can be used to forcefully override the automatically
  detected defaults.
* `title` can be used to set a title for the discussion that overrides
  the title that disqus takes from the page's title tag otherwise.
* `category_id` sets the category id.  Look at the disqus documentation
  for more information.


