jonschlinkert / grunt-readme

DEPRECATED. Use Verb instead
https://github.com/assemble/verb
Other
30 stars 10 forks source link

rename "include" to "default" or something else. #17

Open jonschlinkert opened 11 years ago

jonschlinkert commented 11 years ago

So that the include mixin allows you to include content from any file in any directory.

dylang commented 10 years ago

I agree. I spent an hour trying to figure out why my new template wouldn't work.

Another idea is for include to default to the user directory, and fall back to the built-in templates when a file isn't found. This way we can override just the ones we want to change.

jonschlinkert commented 10 years ago

Agreed, something needs to change. For the time being, if you use ,<%= _.doc("foo.md") %>, grunt-readme will look for the file in your local ./docs folder. You should be able to override this in the task options:

readme: {
  options: {
    docs: './foo/bar'
  }
}
jonschlinkert commented 10 years ago

I know that doesn't resolve this, just thought it might help in the meantime