[all] Add build readme script #996
Merged
Conversation
This file contains 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
kof
reviewed
Jan 21, 2019
scripts/build-readme.js
Outdated
|
|
||
| See our website [${ | ||
| packageJSON.name | ||
| }](https://cssinjs.org/${getDocsPath()}?v=v10.0.0-alpha.8) for more information. |
There was a problem hiding this comment.
Good catch, I moved the creating of readmes now into the rollup config
There was a problem hiding this comment.
can we keep them as a separate helper script outside of rollup config to keep the config more readable and declarative?
kof
reviewed
Jan 21, 2019
|
|
||
| There's an instance of JSS already set up with all of the default plugins, exported as `jss`. |
There was a problem hiding this comment.
Just realized we have no good place where all exports from the starter kit are documented. We should probably create a docs/jss-starter-kit.md and list them all there
kof
approved these changes
Jan 21, 2019
bhupinderbola
pushed a commit
to bhupinderbola/jss
that referenced
this pull request
Sep 17, 2019
* Add readme script * Move creating the readmes to rollup * Update readmes * Fix readme content * Move creating readme into own script * Update readme content
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.
What would you like to add/fix?
This adds a script to create the readmes for the repositories automatically.
Not sure if this should be an own script or be executed when we build all of the packages.
Corresponding issue (if exists): #932