JSPM – hexo-related-popular-posts@0.1.7

Package Exports

hexo-related-popular-posts

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (hexo-related-popular-posts) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

A hexo plugin that generates a list of links to related posts or popular posts. Also , this plugin can display Visitor Counts (Pageview) on posts.

Overview

Generate related list of posts. (Relevance of tags & Relevance of contents)
Generate popular list of posts. (Sort posts by page views)
Get Page Views information on posts. (Visitor Counter)

A hexo plugin that generates a list of links to related posts based on tags , and plugin that generates a list of links to popular posts base on page view of Google Analytics. Popular posts is need Google Analytics API.

Also , this plugin can generates a list of links to related posts based on contents. In addition , plugin supports different styles, thumbnails, is fully customizable and includes caching for improved performance.

DEMO & Documents

DEMO : My Posts has generated related posts and popular posts like this. In addition, the page view is displayed like this.
Documents : read me (Japanese)

Installation

$ npm install hexo-related-popular-posts --save

Usage

1. Edit your theme

First, add the following popular_posts() helper tag in template file for article. Please edit themes/(your-theme)/layout/_partial/your_template.ejs.

  <%-
    popular_posts()
  %>

2. Run server

Starts a local server. By default, this is at http://localhost:4000/.

$ hexo server

A related article is displayed . The above is an easy introduction usage.

More settings

If you want to make more detailed settings , please see below for the details.

Also , this plugin can set the following options. Please edit your config file _config.yml.

# More detailed settings
popularPosts:

  # (optional) Popular posts options
  googleAnalyticsAPI:
    clientId: ******.apps.googleusercontent.com
    serviceEmail: *****@developer.gserviceaccount.com
    key: /hexo-project-root/path/to/google-services.pem
    viewId: 12345678
    dateRange: 30
    expiresDate: 10
    pvMeasurementsStartDate: 2015/11/01
    rankingSheet: rankingSheet.txt
    # cache:            # (Deprecated) This options is Deprecated > v0.1.3
    #  path: hexo-related-popular-posts-ga-cached.json  # (Deprecated) This options is Deprecated > v0.1.3
    #  expiresDate: 10  # (Deprecated) This options is Deprecated > v0.1.3
    
  # (optional) Advanced Related posts options
  morphologicalAnalysis: 
    negativeKeywordsList: pluginSettings/hexo-rpp-negativewords.txt
    limit: 300
    
  # (optional) Related post's weight options
  weight:
    tagRelevancy: 1.0
    contentsRelevancy: 1.0
    
  # (optional) Cache options (Improve generation speed.)
  cache:
    path: cache/hexo-popular-related-posts-ga-cached.json
    
  # (optional) Log options
  log: true

Options of hepler

popular_posts() helper can set the following options.

option	description	default
maxCount	Maximum count of a list	`5`
ulClass	Class name of element	`'popular-posts'`
PPMixingRate	Mixing ratio of popular posts and related posts	`0.0`(=Related posts only)
isDate	visible the date	`false`
isImage	visible the image	`false`
isExcerpt	visible the excerpt	`false`
PPCategoryFilter	Option to fix category on Popular Posts	`undefined`

Helper's Option Examples

Related Articles will generate 5 posts. Also, Image of Articles generate .

  <%-
    popular_posts_json({ maxCount: 5 , ulClass: 'popular-posts' , PPMixingRate: 0.0 , isImage: true})
  %>

Popular Articles will generate 10 posts . (Popular posts is need Google Analytics API.)

  <%-
    popular_posts_json({ maxCount: 10 , ulClass: 'popular-posts' , PPMixingRate: 1.0 })
  %>

If you want customize list's html , please use Customize HTML

Popular posts base on page view of Google Analytics. Popular posts is need Google Analytics API. Please edit your config file _config.yml and set the following options.

Please see https://www.npmjs.com/package/ga-analytics

popularPosts:
  googleAnalyticsAPI:
    clientId: ******.apps.googleusercontent.com
    serviceEmail: *****@developer.gserviceaccount.com
    key: /hexo-project-root/path/to/google-services.pem
    viewId: 12345678
    dateRange: 30       # (Optional) The period you want to get by Google Analytics page view. Default = 30
    expiresDate: 10     # (optional) Expiration date of cache file. Default = 10
    # cache:            # (Deprecated) This options is Deprecated > v0.1.3
    #  path: hexo-related-popular-posts-ga-cached.json  # (Deprecated) This options is Deprecated > v0.1.3
    #  expiresDate: 10  # (Deprecated) This options is Deprecated > v0.1.3

If you want to use the environment variable. Please set the following. If you use Windows , please see youtube about what how to set environment variable.

$ export GOOGLEAPI_CLIENTID="******.apps.googleusercontent.com"
$ export GOOGLEAPI_EMAIL="*****@developer.gserviceaccount.com"
$ export GOOGLEAPI_KEY="/path/to/google-services.pem"
$ export GOOGLEAPI_ANALYTICS_TABLE="ga:12345678"

popularPosts:
  googleAnalyticsAPI:
    # clientId: ******.apps.googleusercontent.com
    # serviceEmail: *****@developer.gserviceaccount.com
    # key: /hexo-project-root/path/to/google-services.pem
    # viewId: 12345678
    dateRange: 60
    expiresDate: 10

This plugin that can generates a list of links to related posts based on content's keywords and internal link. Support language is as follow. Please cooperate with support of other languages.

If you want to generates a list of links to related posts based on contents , please set the morphologicalAnalysis option.

popularPosts:
  morphologicalAnalysis:

More detailed options can be set as follows.

popularPosts:
  morphologicalAnalysis: 
    negativeKeywordsList: hexo-rpp-negativewords.txt  # (optional) If you want to exclude the keywords for analytics , set the exclude file.
    limit: 300              # (optional) If you want to limit the number of keywords for analytics , set the number.
  weight:                   # (optional)
    tagRelevancy: 1.0       # (optional) Weight of tag relevancy. Default = 1.0
    contentsRelevancy: 1.0  # (optional) Weight of contents relevancy. Default = 1.0

For example, hexo-rpp-negativewords.txt can describe a regular expression as follows. Please enter the keywors of each data separated by newlines.

^.$
^[0-9]+$
^String to exclude from related keywords$
^関連キーワードから除外しておきたい文字列を正規表現で指定する$
^要从相关关键字排除的字符串$
...

Cache

This option improves the generation speed. please set the cache option.

popularPosts:
  cache:
    path: hexo-popular-related-posts-cached.json

Log

When this option is enabled, logs are displayed. please set the log option.

popularPosts:
  log: true  # (Optional) When this option is enabled, logs are displayed. Default = true

Customize HTML

If you want customize list's html , please use popular_posts_json() helper and htmlGenerator() register .

First , please edit themes/(your-theme)/layout/_partial/your_article_template.ejs .

<%-
    htmlGenerator( 
        popular_posts_json({ maxCount: 5 , ulClass: 'popular-posts' , PPMixingRate: 0.0 , isDate: true , isImage: true , isExcerpt: true})
    )
%>

Second , please edit themes/(your-theme)/scripts/your_scripts.js .

// Examples of helper
hexo.extend.helper.register('htmlGenerator', function(args){
  if(!args || !args.json || args.json.length == 0)return "";
  
  var returnHTML = "";
  
  function generateHTML(list){
    
    var ret = "";
    ret += "<li class=\"" + args.class + "-item\">";
    
    if(list.date && list.date != ""){
        ret += '<div class="'+args.class+'-date">' + list.date + "</div>";
    }
    
    if(list.img && list.img != ""){
        ret += '<div class="'+args.class+'-img">' + '<img src="'+list.img+'" />' + "</div>";
    }
    ret += '<div class="'+args.class+'-title"><h3><a href="' + list.path + '" title="'+ list.title +'" rel="bookmark">'+ list.title + "</a></h3></div>";
    if(list.excerpt &&  list.excerpt != ""){
        ret += '<div class="'+args.class+'-excerpt"><p>' + list.excerpt + "</p></div>";
    }
    
    ret +=  "</li>";
    return ret;
  }
  
  for(var i=0; i<args.json.length; i++){
      returnHTML += generateHTML(args.json[i]);
  }
  
  if(returnHTML != "")returnHTML = "<ul class=\"" + args.class + "\">" + returnHTML + "</ul>";
  
  return returnHTML;
});

Visitor Counter

This plugin can get Page Views information on posts. please set the pvMeasurementsStartDate option. Also , Visitor Counter is need Google Analytics API .

First , please edit your config file _config.yml.

popularPosts:
  # (optional) Popular posts options
  googleAnalyticsAPI:
    clientId: ******.apps.googleusercontent.com
    serviceEmail: *****@developer.gserviceaccount.com
    key: /hexo-project-root/path/to/google-services.pem
    viewId: 12345678
    dateRange: 30
    expiresDate: 10
    pvMeasurementsStartDate: 2015/11/01

Second , add the following popular_posts_pv() helper tag in template file for article. please edit themes/(your-theme)/layout/_partial/your_article_template.ejs .

    This post's Visitor Counts is 
    <%- popular_posts_pv() %> 
    views.

Ranking Sheet

This plugin can make Page Views Ranking Sheet. If you want to use , please set the rankingSheet option. Ranking Sheet is need Google Analytics API .

popularPosts:
  # (optional) Popular posts options
  googleAnalyticsAPI:
    clientId: ******.apps.googleusercontent.com
    serviceEmail: *****@developer.gserviceaccount.com
    key: /hexo-project-root/path/to/google-services.pem
    viewId: 12345678
    dateRange: 30
    expiresDate: 10
    pvMeasurementsStartDate: 2015/11/01
    rankingSheet: rankingSheet.txt

License

MIT

Thank you for a wonderful plugin.

Hexo : http://hexo.io/
ga-analytics : https://github.com/sfarthin/ga-analytics
kuromoji.js : https://github.com/takuyaa/kuromoji.js

hexo-related-popular-posts