Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the simple generator format #152

Closed
sindresorhus opened this issue Jan 27, 2013 · 4 comments
Closed

Document the simple generator format #152

sindresorhus opened this issue Jan 27, 2013 · 4 comments
Milestone

Comments

@sindresorhus
Copy link
Member

Couldn't find a mention or example of the new simplified format anywhere.

@mklabs you mind adding some docs?

@mklabs
Copy link
Contributor

mklabs commented Jan 27, 2013

Yeah, the "simple" format is not very standard, at least in the long run, I don't want it to be that way. I also didn't tested it thoroughly, so that's why it wasn't really documented, but will do.

Reference: https://github.com/yeoman/generators/blob/master/test/fixtures/custom-generator-simple/main.js

@sindresorhus
Copy link
Member Author

But the format does makes it easier when all you want to do is to just scaffold a few files.

@mklabs
Copy link
Contributor

mklabs commented Jan 27, 2013

Sure thing. Will do.

This is part of the top level, non generated documentation. I still need to find a few hours to do that. More a tutorial / guide thing than API documentation.

@addyosmani
Copy link
Member

As the generator system and docs have come quite a long way since this ticket, closing. Let's address any improvements to the current docs based on specific sections that could use more work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants