nodebb-plugin-blog-comments - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #ai #llm #android #rust #docker #macos #windows #kubernetes #awesome-list #security #mcp #openai

nodebb-plugin-blog-comments

(★ 100)

Lets NodeBB act as a comments engine/widget for your blog

File Explorer

Download Latest Version (.zip)

- - comments.css
- - .eslintrc
  - admin.js
  - general.js
  - ghost.js
  - main.js
  - wordpress.js
.eslintrc
.gitattributes
.gitignore
.npmignore
library.js
LICENSE
package-lock.json
package.json
plugin.json
README.md
yarn.lock

# Installation Guide

1. Get the code

git clone https://github.com/psychobunny/nodebb-plugin-blog-comments

Downloads the entire project code from GitHub to your computer.

cd nodebb-plugin-blog-comments

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install nodebb-plugin-blog-comments

Downloads and installs the libraries listed in package.json.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# NodeBB Blog Comments

Lets NodeBB act as a comments engine/widget for your blog. Currently supports both [Ghost](https://ghost.org/) and [WordPress](http://wordpress.org/). There is a separate repo for [PencilBlue](https://github.com/theunknownartisthour/nodebb-comments-pencilblue) support. If you'd like to see support for other CMS/blog systems, please submit an issue on our tracker.

The comments are exposed to any plugin you have built into the core, so it is completely possible to have emoticons, embedded video, and/or whatever else you want in the comments section of your blog.

Articles are published to a forum category of your choice, and will gain a tag that links it back to the original article.

## What's new in 0.8x

* The WP-JSON plugin is no longer required. This plugin will now use the built-in JSON API.
* The comments snippet has changed, please update your integration code as necessary
* Fixed a bug that caused errors when no [ACAO](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin) header was defined

## Upgrading to 0.6x

Getting `Unexpected end of JSON input` for `/comments/publish`? On your blog's post template (ex. `post.hbs` for Ghost) where you have installed the blog comments script, find the following line:

```
<script id="nbb-markdown" type="text/markdown">{{../post.markdown}}</script>
```

and above, add:

```
<script id="nbb-title" type="text/markdown">{{../post.title}}</script>
```

## What's new in 0.3x

* Fixed quite a few server crashes (especially when publishing)
* Compatible with NodeBB 0.6x+ and Ghost 0.5.10
* Added tags support for Ghost
* Added comment support in general

## Screenshots

![blog comments](http://i.imgur.com/pPO42Hy.png)

## Installation

First install the plugin:

npm install nodebb-plugin-blog-comments

Activate the plugin in the ACP and reboot NodeBB. Head over to the Blog Comments section in the ACP and select the Category ID you'd like to publish your blog content to (default is Category 1). Make sure you put the correct URL to your blog.

### Ghost Installation

Paste this any where in `yourtheme/post.hbs`, somewhere between `{{#post}}` and `{{/post}}`. All you have to edit is line 3 (`nbb.url`) - put the URL to your NodeBB forum's home page here.

```html
<a id="nodebb-comments"></a>
<script type="text/javascript">
var nbb = {};
nbb.url = '//your.nodebb.com'; // EDIT THIS
nbb.cid = 1;	// OPTIONAL. Forces a Category ID in NodeBB.
				//  Omit it to fallback to specified IDs in the admin panel.

(function() {
nbb.articleID = '{{../post.id}}';
nbb.tags = [{{#../post.tags}}"{{name}}",{{/../post.tags}}];
nbb.script = document.createElement('script'); nbb.script.type = 'text/javascript'; nbb.script.async = true;
nbb.script.src = nbb.url + '/plugins/nodebb-plugin-blog-comments/lib/ghost.js';
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(nbb.script);
})();
</script>
<script id="nbb-title" type="text/markdown">{{../post.title}}</script>
<script id="nbb-markdown" type="text/markdown">{{../post.markdown}}</script>
<noscript>Please enable JavaScript to view comments</noscript>
```

If you wish, you can move `<a id="nodebb-comments"></a>` to where you want to place the actual comments widget.

### Wordpress Installation

Replace the contents of `/wp-content/themes/YOUR_THEME/comments.php` with the following (back-up the old comments.php, just in case):

```html
<?php
if ( post_password_required() )
	return;
?>

<a id="nodebb-comments"></a>
<script type="text/javascript">
	const nodeBBURL = '//your.nodebb.com';
	const wordpressURL = '<?php get_site_url(); ?>';
	const articleID = \''.get_the_ID().'\';
	const categoryID = null; 	// OPTIONAL. Forces a Category ID in NodeBB.
								//  Omit it to fallback to specified IDs in the admin panel.

(function() {
	var nbb = document.createElement('script'); nbb.type = 'text/javascript'; nbb.async = true;
	nbb.src = nodeBBURL + '/plugins/nodebb-plugin-blog-comments/lib/wordpress.js';
	(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(nbb);
	})();
</script>
<noscript>Please enable JavaScript to view comments</noscript>
```

### General - PHP example
Paste this any where that you want load commenting system. All you have to edit is line 3 (`nodeBBURL`) - put the URL to your NodeBB forum's home page here. You can also use any template engine (hbs, eco...) instead of PHP.

```html
	<a id="nodebb-comments"></a>
	<script type="text/javascript">
	var nodeBBURL = '//your.nodebb.com',

<?php
		echo "articleID = " .getId().";";
		$obj = new stdClass();
		$obj->title_plain = "";
		$obj->url="";
		$obj->tags = [];
		$obj->markDownContent= "";
		$obj->cid = 1; // OPTIONAL. Forces a Category ID in NodeBB.
						// Omit it to fallback to specified IDs in the admin panel.
		echo "var articleData =" .json_encode($obj).";";
	?>

(function() {
	var nbb = document.createElement('script'); nbb.type = 'text/javascript'; nbb.async = true;
	nbb.src = nodeBBURL + '/plugins/nodebb-plugin-blog-comments/lib/generalphp.js';
	(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(nbb);
	})();
	</script>
	<noscript>Please enable JavaScript to view comments</noscript>
```

You must have some getId() function on your website, for example:

**For a PHP website**

```php
    <?php
        function getId(){
            $id = 0;
            // unique id for each page of your website
            return $id;
        }
    ?>
```

If you don't have such ID, you can use this function that generates a unique ID from the URL:

```php
    <?php
        function getId(){
            return stringToInteger($_SERVER['REQUEST_URI']);
        }
        function stringToInteger($string) {
            $string = md5($string);
            $output = '1';
            for ($i = 0; $i < strlen($string); $i++) {
                $output .= (string) ord($string[$i]);
            }
            return (int) $output;
        }
    ?>
```

### Comments Counter

You may optionally put a "# of comments" counter anywhere on the page with the following code:

```html
<span id="nodebb-comments-count"></span> Comments
```

A mechanism to query the number of comments on another separate page will be available in a future release.

### Author and Category information

![](http://i.imgur.com/NyLs4LQ.png)

To use NodeBB's category and author information (instead of using Ghost's user/tag system), there are two elements that this plugin searches for:

```html
Published by <span id="nodebb-comments-author"></span> in <span id="nodebb-comments-category"></span>
```

### Publishing

Head over to the article that you'd like to publish. The code will detect if you're both an administrator of your blog and NodeBB (so ensure that you're logged into both) and will display a publish button if so.

You may also create a `publishers` group in NodeBB to allow a group of regular users to have publish rights.

### Multiple blogs

You may use a comma-separated entry of blogs in the ACP to support publishing from a network of separate blogs to your forum. You can also choose to put each blog in its own dedicated category, or place them all into one category.

## Sites using this plugin

* [NodeBB's Blog](http://blog.nodebb.org) (Wordpress).
* [The Unknown Artist Hour](http://theunknownartisthour.com) (Ghost).
* [Strange Adventures In](https://strangeadventures.in) (Ghost).
* [V2MM](https://v2mm.tech) (Ghost).

Please submit a PR to add your site here :)

## TODO

* Republishing (for now you can just edit both the article and the published blog).
* Pull CSS files from appropriate plugins? Ability to load custom CSS to style widget.