docs: fix codeblock in FAQ section of readme (#36) #50
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
On w.org code-blocks in FAQ are not rendered properly. Using single backticks does not give the best experience in rendered MarkDown, e.g. on GitHub, but it's still readable and it's correctly rendered on the plugin page. We might want to migrate to a dedicated readme.txt for deployment in the future, but for now let's use the cheap solution so we are not blocked.
Closed
stklcode
changed the title
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.
On w.org code-blocks in FAQ are not rendered properly. Using single backticks does not give the best experience in rendered MarkDown, e.g. on GitHub, but it's still readable and it's correctly rendered on the plugin page.
We might want to migrate to a dedicated readme.txt for deployment in the future, but for now let's use the cheap solution so we are not blocked.