18F / generator-uswds

A Yeoman generator for the U.S. Web Design Standards
Other
1 stars 3 forks source link

Incorporate the Jekyll template as a generator? #6

Open shawnbot opened 7 years ago

shawnbot commented 7 years ago

If we decide to go with publishing the Jekyll template as a generator (https://github.com/18F/federalist-uswds-template/issues/1), then we could nix the git submodule here and instead compose it:

npm i --save generator-uswds-jekyll
// app/index.js
install: function() {
  this.composeWith('uswds-jekyll');
},

Of course, the other way that we could do this is to keep the scaffolding in this repo and just re-run the generator to refresh the assets in the template repo. That would mean:

  1. Remove the git submodule and copy the template files into this repo under app/templates/jekyll.
  2. Add a package.json to the template repo that runs yo uswds --jekyll --sass to update. (There's currently no update script because that repo is the "source of truth" for templates.)

@hbillings @cmc333333, what do you think?

shawnbot commented 7 years ago

Aaand just to make things a bit more complicated: The other option is to turn the theme repo into the generator.