docs(readme): Fix markdown error #227
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
README contained unescaped & unclosed `<style>` tag that made almost the whole README unreadable on the npm package page; see: https://www.npmjs.com/package/style-loader This is a good test page to see how READMEs will display on npm: https://revin.github.io/marky-markdown/
|
I reported it to |
mgol
added a commit
to mgol/style-loader
that referenced
this pull request
May 6, 2017
PR webpack-contrib#227 made the README not broken completely on the npm package page (https://www.npmjs.com/package/style-loader) but didn't make the code block a real code block. Backticks are only used to delimit code blocks when used on the top level of the Markdown file; once they appear in an HTML block they're treated as regular symbols. The proper fix is to use the `<code>` tag.
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 kind of change does this PR introduce?
A docs bugfix.
Did you add tests for your changes?
N/A
If relevant, did you update the README?
Yes.
Summary
README contained unescaped & unclosed
<style>tag that made almost the wholeREADME unreadable on the npm package page; see:
https://www.npmjs.com/package/style-loader
Does this PR introduce a breaking change?
No.
Other information
This is a good test page to see how READMEs will display on npm:
https://revin.github.io/marky-markdown/