node package manager
Stop wasting time. Easily manage code sharing in your team. Create a free org »

generator-jekyllstarter

Jekyll Starter Generator Build Status

Yeoman generator

What is Jekyll Starter?

Jekyll Starter is a bootstrap project for quickly creating a blog site based on Jekyll. The starter project provides a foundation based on Lanyon, which is a flavor of Poole.

In addition to the clean, minimalistic styling borrowed from Lanyon, Jekyll Starter provides the following functionality out-of-the-box:

  • Comments using Disqus
  • Google Analytics Integration with superProxy
    • Page view counter
    • Website counter
  • Social sharing using AddThis
  • Author following using AddThis
  • Tag visualization per post
  • Archive organized by tags
  • Customizable profile picture in sidebar and about page
  • Grunt based build with CSS merge and minification

This is the base on which anandmanisankar.com is built.

Usage

Pre-requisites (Optional)

You will need a Disqus account, AddThis account and Google Analytics Tracking ID, if you want to integrate your blog with these services. Ensure you have enabled share and follow tools in AddThis. To make use of the Google Analytics integration, ensure you set-up and configure the Google Analytics Super Proxy as described here. Also ensure that your super proxy returns 'ga:pageviews' and 'ga:pagePath'. (To tackle the CORS issue with super proxy, refer to my StackOverflow response)

Use the Jekyll Starter Yeoman generator to scaffold your blog in a matter of seconds.

To install generator-jekyllstarter from npm, run:

npm install -g generator-jekyllstarter

Now, initiate the generator:

yo jekyllstarter

Answer the questions asked by the generator, and you're blog is ready!

You can also generate a new post:

yo jekyllstarter:newpost

What is Yeoman?

Trick question. It's not a thing. It's this guy:

Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.

Not every new computer comes with a Yeoman pre-installed. He lives in the npm package repository. You only have to ask for him once, then he packs up and moves into your hard drive. Make sure you clean up, he likes new and shiny things.

npm install -g yo

Yeoman Generators

Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.

To install generator-jekyllstarter from npm, run:

npm install -g generator-jekyllstarter

Finally, initiate the generator:

yo jekyllstarter

Bugs / Feature Requests

You can report issues or request new features here.

License

MIT