Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eddywashere/generator-ironsmith
A yeoman generator for scaffolding metalsmith sites with gulp
https://github.com/eddywashere/generator-ironsmith
Last synced: 25 days ago
JSON representation
A yeoman generator for scaffolding metalsmith sites with gulp
- Host: GitHub
- URL: https://github.com/eddywashere/generator-ironsmith
- Owner: eddywashere
- Created: 2015-06-22T04:42:38.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-12-20T23:52:37.000Z (almost 9 years ago)
- Last Synced: 2024-09-13T17:09:55.265Z (about 2 months ago)
- Language: CSS
- Size: 172 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# generator-ironsmith
> A [Yeoman](http://yeoman.io) generator for working with metalsmith
Check out a [live demo](http://eddywashere.github.io/ironsmith-demo) of what you can build with this generator.
## Quick start
Install dependencies for this generator
```bash
npm install -g yo generator-ironsmith
```
Create a fully functional metalsmith site with
```bash
yo ironsmith
```
This should run `npm install` automatically.
To preview the site, run
```bash
gulp preview
```
To add pages use the following command
```bash
yo ironsmith:page
```
To add posts use the following command
```bash
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](https://npmjs.org) 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.*
```bash
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:
```bash
npm install -g generator-ironsmith
```
Finally, initiate the generator:
```bash
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](http://gruntjs.com) and [Bower](http://bower.io), check out the complete [Getting Started Guide](https://github.com/yeoman/yeoman/wiki/Getting-Started).
## License
MIT