Update npm workflow#1036
Conversation
| - stylesheets/ | ||
| ``` | ||
|
|
||
| `require('uswds')` will load all of Draft U.S. Web Design Standard's JavaScript onto the page. The uswds module itself does not export anything. |
There was a problem hiding this comment.
Hey! A few comments:
I'd add "the" before "Draft U.S. Web Design Standard's JavaScript." Also, I'd recommend capitalizing "uswds" in the second sentence (because USWDS is an abbreviation of a proper noun).
There was a problem hiding this comment.
Added backticks to uswds in 6436fe4 rather than capitalizing to match how we talk about it in the code.
|
Giving some more context around the discussion in all the
|
|
@rogeruiz maybe one more thing to add to the checklist:
|
Ran the command to build the assets: `gulp build`
209c35e to
d3c1b5a
Compare
|
|
||
| ```html | ||
| <link rel="stylesheet" href="/path/to/your/assets/css/uswds-0.9.0.css"> | ||
| <link rel="stylesheet" href="/path/to/your/assets/css/lib/uswds.min.css"> |
There was a problem hiding this comment.
I think it should be /path/to/your/assets/css/lib/uswds-0.9.0/uswds.min.css.
|
LGTM, just had one comment. |
| of your downloaded assets. And the un-minified version is better if you are in a | ||
| development environment or would like to debug the CSS or JavaScript assets in | ||
| the browser. The examples below recommend using the minified versions. | ||
|
|
There was a problem hiding this comment.
I sort imagined this paragraph would go below the link examples. Thoughts @kategarklavs? I think it's also obvious that minified is .min so not sure if we need it?
There was a problem hiding this comment.
Hey @maya — I'm totally OK with this comment appearing below the examples (we'll just need to update the last sentence to say, "The examples above recommend using the minified version."). As far as the necessity of the explanation goes: My sense is that this explanation is to help out newer users, but if it's overkill, I'm also OK with removing it.
This updates the "Using npm" docs. This also removes the version number from the CSS and JS files, while keeping it in the parent directory and zip file. We recompiled the
dist/directory.