hexo-generator-json-content

Hexo (https://hexo.io/) plugin to generate a JSON file for generic use or consumption with the contents of posts and pages.

It's useful to serve compact and agile content data for microservices like AJAX site search, Twitter typeahead or public API.

Installation

npm i -S hexo-generator-json-content

Usage

Hexo will run the generator automagically when you run hexo serve or hexo generate. 😏

Using the default settings, the content.json file looks like the following structure:

meta: {
    title: hexo.config.title,
    subtitle: hexo.config.subtitle,
    description: hexo.config.description,
    author: hexo.config.author,
    url: hexo.config.url
},
pages: [{ //-> all pages
    title: page.title,
    slug: page.slug,
    date: page.date,
    updated: page.updated,
    comments: page.comments,
    permalink: page.permalink,
    path: page.path,
    excerpt: page.excerpt, //-> only text ;)
    keywords: null //-> it needs settings
    text: page.content, //-> only text minified ;)
    raw: page.raw, //-> original MD content
    content: page.content //-> final HTML content
}],
posts: [{ //-> only published posts
    title: post.title,
    slug: post.slug,
    date: post.date,
    updated: post.updated,
    comments: post.comments,
    permalink: post.permalink,
    path: post.path,
    excerpt: post.excerpt, //-> only text ;)
    keywords: null //-> it needs settings
    text: post.content, //-> only text minified ;)
    raw: post.raw, //-> original MD content
    content: post.content, //-> final HTML content
    categories: [{
        name: category.name,
        slug: category.slug,
        permalink: category.permalink
    }],
    tags: [{
        name: tag.name,
        slug: tag.slug,
        permalink: tag.permalink
    }]
}]

hexo.util.stripHTML is used to get only clean text for excerpt and text fields.

Configuration

You can set some options in _config.yml to generate a custom content.json.

Default options are as follows:

jsonContent:
  meta: true
  keywords: false # language name option
  dateFormat: undefined # format string
  pages:
    title: true
    slug: true
    date: true
    updated: true
    comments: true
    path: true
    link: true
    permalink: true
    excerpt: true
    keywords: true # but only if root keywords option language was set
    text: true
    raw: false
    content: false
  posts:
    title: true
    slug: true
    date: true
    updated: true
    comments: true
    path: true
    link: true
    permalink: true
    excerpt: true
    keywords: true # but only if root keywords option language was set
    text: true
    raw: false
    content: false
    categories: true
    tags: true

Date formats

dateFormat option sets an output format for datetime objects date and updated.

It uses moment to do the trick, so any string accepted by format method can be used.

If not defined, default format is the JSON.stringify result for Date objects.

Keywords

keywords options extracts keywords from excerpt using michaeldelorenzo/keyword-extractor, NPM package to create a keywords array from a string by removing stopwords.

If keyword-extractor don't supports your language, don't worry! It's disabled by default.

You can exclude meta, pages or posts contents from content.json by setting meta, pages, or posts to false.

To exclude individual fields from pages or posts output set their config values to false.

To exclude specific paths, use an ignore list. Any path that contains at least one of the listed substrings will be skipped from indexing. For example:

jsonContent:
  ignore:
    - path/to/a/page
    - url/to/one/post
    - an-entire-category
    - specific.file
    - .ext # a file extension

Output

By default, the json output includes meta, pages and posts sections. If only one section is enabled by config, the json output will consist of a single array.

For example, the following config enables only posts, showing title, date, path, and text fields:

jsonContent:
  meta: false
  pages: false
  posts:
    title: true
    date: true
    path: true
    text: true
    raw: false
    content: false
    slug: false
    updated: false
    comments: false
    link: false
    permalink: false
    excerpt: false
    categories: false
    tags: false

The result content.json will look like this:

[{ //-> only published posts
  title: post.title,
  date: post.date,
  text: post.content, //-> only text minified ;)
  path: post.path
}]

Usage examples

Coming soon...

yscoder/hexo-generator-json-content