Add FAQ for markdown #10611
Merged
Add FAQ for markdown #10611
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
Signed-off-by: jolheiser <john.olheiser@gmail.com>
jolheiser
added
type/docs
guillep2k
reviewed
Mar 5, 2020
GiteaBot
added
the
lgtm/need 2
Signed-off-by: jolheiser <john.olheiser@gmail.com>
jolheiser
commented
Mar 5, 2020
|
|
||
| ## Why is my markdown broken | ||
| In Gitea version `1.11` we moved to [goldmark](https://github.com/yuin/goldmark) for markdown rendering, which is [CommonMark](https://commonmark.org/) compliant. | ||
| If you have markdown that worked as you expected prior to version `1.11` and after upgrading it's not working anymore, please look through the CommonMark spec to see whether the problem is due to a bug or non-compliant syntax. |
There was a problem hiding this comment.
@guillep2k I re-worded a little, is this better?
guillep2k
approved these changes
Mar 5, 2020
GiteaBot
added
lgtm/need 1
zeripath
approved these changes
Mar 5, 2020
GiteaBot
added
lgtm/done
|
Ping lgtm |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Resolves #10223
Some changes to markdown are actually not bugs, but rather non-compliant with CommonMark.
Sometimes there are actually compliant alternatives, though, so it may be important to make users aware. 馃檪