https://github.com/thejohnfreeman/jquery-disqus

A jQuery plugin for supporting Markdown and syntax highlighting in Disqus comments.
https://github.com/thejohnfreeman/jquery-disqus

Last synced: 2 months ago
JSON representation

A jQuery plugin for supporting Markdown and syntax highlighting in Disqus comments.

• Host: GitHub
• URL: https://github.com/thejohnfreeman/jquery-disqus
• Owner: thejohnfreeman
• Created: 2012-04-25T05:50:13.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2012-08-26T03:35:05.000Z (over 12 years ago)
• Last Synced: 2024-10-10T18:24:44.548Z (3 months ago)
• Language: JavaScript
• Size: 90.8 KB
• Stars: 9
• Watchers: 5
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
This [jQuery][jq] plugin enhances your [Disqus][dq] comments with Markdown and

syntax highlighting.

[jq]: http://jquery.com/ "jQuery, a JavaScript library for DOM manipulation"

[dq]: http://disqus.com/ "Disqus, a comment app for blogs"

## Use

Include appropriate dependencies in your ``:

```html

```

Then configure Disqus and run the plugin from anywhere:

```js

$(document).ready(function() {

  /* We do not change the Disqus API. If you want to pass options to

   * Disqus, do it like they expect: by setting global variables. */

  disqus_shortname  = "example";

  disqus_identifier = "/path/to/slug";

  $.disqus();

});

```

## Caveats

Be aware that the Disqus embed script manipulates comments, e.g.,

changing long URLs into anchor elements (``) or newlines into line-break

elements (`
`).

These manipulations must be reversed for the original Markdown to parse as

the comment author intended. I have made a minor attempt to address these two

specific manipulations, but there are others that my script will not

handle correctly.


An ideal solution would essentially require rewriting the Disqus embed script

and replacing the transformation that Disqus provides. I suspect it would be

an easy change for Disqus developers with access to the source. For me, it is

too much reverse engineering to be justified.

I have not tested this script with Disqus 2012. My suspicion is that browsers

will prohibit its access to the comments within the Disqus iframe, thus

disabling it.

## History

This plugin was branched off the last published version of the [jQuery Disqus

plugin by Lance Pollard][lance]. Besides being broken by the time I discovered

it (likely due to changes in the Disqus API), I believe the original plugin

tried to do too much. I have made several changes:

- Use a single entry point, `$.disqus()`.

- Expect Disqus configuration to occur outside the call to this plugin and

  to follow the expectations documented by [Disqus][dq-config].

- Use Disqus's published Universal Code instead of a custom AJAX call.

- Support Markdown conversion using [Showdown][sd].

- Support syntax highlighting with [Prettify][pretty].

- Remove everything else, e.g. `ready()` and `add()`.

[lance]: http://code.lancepollard.com/jquery-disqus-plugin "jQuery Disqus plugin"

[dq-config]: http://docs.disqus.com/help/2/ "JavaScript configuration variables"

[sd]: https://github.com/coreyti/showdown "Showdown, a JavaScript port of Markdown"

[pretty]: http://code.google.com/p/google-code-prettify/ "Prettify, a JavaScript- and CSS-based syntax highlighter"