docs: refine README.md #121
Open
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
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 cleaned up the markdown to make the code and result more readable.
Note that
--watchis implied can be out. I added--traceas it helps for debugging errors verbosely.Having a warning for needing Ruby seems out of place, so rather listed Ruby as dependency via a badge and in install section.
I added a Jekyll badge which shows
3.9because this works on GH Pages. if your theme works on Jekyll 4, then it can be be3.9, 4.Xrather.Also added a missing bundle config line - if you omit that, then bundle thinks it is running for the user level and not the repo level.