Monorepo README updates #235
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sophshep
approved these changes
Jun 28, 2017
README.md
Outdated
| ## Usage | ||
|
|
||
| The source files included are written in [Sass][sass] (`scss`) You can simply point your sass `include-path` at your `node_modules` directory and import it like this. | ||
| The source files included are written in [Sass][sass] (SCSS). You can point your sass `include-path` at your project's `node_modules` directory and import it like this: |
There was a problem hiding this comment.
I hate myself for this comment but we should capitalize Sass in You can point your sass
mdo
reviewed
Jun 28, 2017
| ## Usage | ||
|
|
||
| The source files included are written in [Sass][sass] (`scss`) You can simply point your sass `include-path` at your `node_modules` directory and import it like this. | ||
| The source files included are written in [Sass][sass] (SCSS). You can point your Sass `include-path` at your project's `node_modules` directory and import it like this: |
There was a problem hiding this comment.
We'll have this provided already with the website-starter repo, but others might not know what include-path is. Can we give context on this for Jekyll, or link to an example?
There was a problem hiding this comment.
Good call. Can we link to a URL about Sass include paths more generally?
| ``` | ||
|
|
||
| You can also import specific portions of the module by importing those partials from the `/lib/` folder. _Make sure you import any requirements along with the modules._ | ||
| You can import individual Primer modules by installing them each with npm, for instance: |
There was a problem hiding this comment.
installing them with instead of installing them each with?
There was a problem hiding this comment.
I can fix that one the new release pr.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I made some updates to the README for the monorepo. If it all looks good, this should be merged into
monobefore merging #230. Here's what's changed:shlanguage identifier to each of the shell examples.scss)" with "(SCSS)" after the Sass link./lib/with instructions for installing individual modules (e.g.primer-navigation) and an example of linking to submodules in thepackagesdirectory of this repo for users who are still figuring out which modules they need.