generator-ghost

generator-ghost

A generator for Yeoman.

Getting Started

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-ghost from npm, run:

$ npm install -g generator-ghost

Finally, initiate the generator:

$ yo ghost

To create a new theme based on Casper, run this subgenerator:

yo ghost:theme-copy-casper NAME-OF-NEW-THEME

That will copy the Casper theme over to a new folder named NAME-OF-NEW-THEME.

Additional setup

Now, make sure you have the grunt-cli tool installed as well as the Bourbon Ruby gem:

npm install -g grunt-cli
gem install bourbon

And run grunt init to compile the SASS, Handlebars, and create the directory for Bourbon:

grunt init

Now, you can run your ghost blog in development like usual:

npm start

Todo

I'd like to revise the generator to run the grunt init build step automatically. If anyone is interested in working with me on that I'm definitely open to contributions: github.com/sethvincent/generator-ghost.

I'd also like to have a theme generator that starts a new theme that's even more bare-bones than Casper.

Feedback

Let me know in the repository issue queue if you find any bugs or have ideas for the project: github.com/sethvincent/generator-ghost/issues

Getting To Know Yeoman

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced.

If you'd like to get to know Yeoman better and meet some of his friends, Grunt and Bower, check out the complete Getting Started Guide.

License

MIT License