A yeoman generator for scaffolding metalsmith sites with gulp
CSS JavaScript HTML
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
generators
.editorconfig
.gitattributes
.gitignore
README.md
package.json

README.md

generator-ironsmith

A Yeoman generator for working with metalsmith

Check out a live demo of what you can build with this generator.

Quick start

Install dependencies for this generator

npm install -g yo generator-ironsmith

Create a fully functional metalsmith site with

yo ironsmith

This should run npm install automatically.

To preview the site, run

gulp preview

To add pages use the following command

yo ironsmith:page

To add posts use the following command

yo ironsmith:post

Learn more about Yeoman

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

npm install -g generator-ironsmith

Finally, initiate the generator:

yo ironsmith

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