docs: updates to the documentation to support new markdown renderer #3672
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
It is not recognized as a heading by the markdown parser without a whitespace.
Old parser considered this the same list, but new parser assumes that these are two separate lists. Technically it should be a nested list, but it is old and shouldn't really matter. I'm doing this change to reduce the diff I need to review after switching to the new markdown parser.
Items nested in the list item, must be indented 3 spaces, not 2 spaces. New parser produced a pretty messed up markup from the invalid markdown.
|
✅ Build karma 576 completed (commit b71bd1951f by @devoto13) |
|
✅ Build karma 575 completed (commit b71bd1951f by @devoto13) |
johnjbarton
approved these changes
Apr 12, 2021
|
🎉 This PR is included in version 6.3.3 🎉 The release is available on: Your semantic-release bot 📦🚀 |
anthony-redFox
pushed a commit
to anthony-redFox/karma
that referenced
this pull request
May 16, 2023
…arma-runner#3672) Companion PR for karma-runner/karma-runner.github.com#62. * docs: fix invalid heading syntax It is not recognized as a heading by the markdown parser without a whitespace. * docs: fix weird syntax to reduce diff Old parser considered this the same list, but new parser assumes that these are two separate lists. Technically it should be a nested list, but it is old and shouldn't really matter. I'm doing this change to reduce the diff I need to review after switching to the new markdown parser. * docs: fix invalid markdown Items nested in the list item, must be indented 3 spaces, not 2 spaces. New parser produced a pretty messed up markup from the invalid markdown. * docs: remove redundant whitespaces in the list items
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.
PR to switch to the new markdown renderer for the documentation website: karma-runner/karma-runner.github.com#62.
Had to put metadata between --- --- (Jekyll syntax) as the previous syntax was not supported by the new Markdown parser. Also several small changes to the markdown syntax for the new Markdown parser (see commits for details).