How to run Node.js before Jekyll build

11th September, 2017 - 2 min. read - in Tutorials - Go to Index

Hey, before scrolling, I've made a tool to help people building presentations the modern way.
If you don't mind, I'd like to ask some feedback about it. Here the starting point to learn more.
Much appreciated!

I’ve recently added a tiny feature on my main website. In a section, it shows the number of words written and published on this blog. A fancy way to suggest that there is also a blog you can use to know more about me.

That number is growing on every article I publish but I don’t want to build and update my website everytime a new article come out.

To solve this issue, I’ve added a tiny ajax request towards a little json file that is updated everytime the blog gets updated. I’ve built a little Node.js script that read all my blog posts generating the correct number, dumping a little json file ready to be committed.

The problem was that I have to run the Node script by hand and sometimes (read: always) I forgot to run it after a new post.

My blog is Jekyll-driven, I’m quite happy with it but I’m not a rubyist and this is why I’ve writter that script in Node.js. I’m much more confortable with it.

After a bit of research, I found out a way to integrate the two with a Jekyll plugin that calls a Node.js script everytime I build my blog for local testing (I usually do it before publishing a new article).

The Jekyll plugin is something like:

module RunNodeBefore
  def self.process(site, payload)
    return if @processed
    system "node build_index.js" 
    @processed = true
  end
end

Jekyll::Hooks.register :site, :pre_render do |site, payload|
  RunNodeBefore.process(site, payload)
end

The relevant line is:

system "node build_index.js"

Yuo need to put that file within the folder _plugins in your Jekyll root folder in order to call it automatically.

As I said, I’m not a rubyist, therefore, I’ve just copy/paste/adapted something I found somewhere.

The important thing is that it just work and I’m pretty sure I won’t forget to update my words.json file anymore.


Spotted a typo or (likely) a grammar error? Send a pull request.