Skip to content

Commit 10081f8

Browse files
authored
Add FAQ for markdown (#10611)
* Add FAQ for markdown * Expand explanation @guillep2k Signed-off-by: jolheiser <[email protected]>
1 parent fb76136 commit 10081f8

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/content/doc/help/faq.en-us.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ Also see [Support Options]({{< relref "doc/help/seek-help.en-us.md" >}})
4646
* [How can I create users before starting Gitea](#how-can-i-create-users-before-starting-gitea)
4747
* [How can I enable password reset](#how-can-i-enable-password-reset)
4848
* [How can a user's password be changed](#how-can-a-user-s-password-be-changed)
49+
* [Why is my markdown broken](#why-is-my-markdown-broken)
4950

5051

5152
## Difference between 1.x and 1.x.x downloads
@@ -302,3 +303,8 @@ There is no setting for password resets. It is enabled when a [mail service]({{<
302303
- In your account `Settings -> Account` page (this method **requires** you to know your current password).
303304
- By using the `Forgot Password` link.
304305
If the `Forgot Password/Account Recovery` page is disabled, please contact your administrator to configure a [mail service]({{< relref "doc/usage/email-setup.en-us.md" >}}).
306+
307+
## Why is my markdown broken
308+
In Gitea version `1.11` we moved to [goldmark](https://github.com/yuin/goldmark) for markdown rendering, which is [CommonMark](https://commonmark.org/) compliant.
309+
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.
310+
If it is the latter, _usually_ there is a compliant alternative listed in the spec.

0 commit comments

Comments
 (0)