mirror of
https://github.com/go-gitea/gitea
synced 2024-08-19 22:00:48 +02:00
GH has different HardBreaks behaviour for markdown comments and documents. Comments have hard breaks and documents have soft breaks - therefore Gitea's rendering will always be different from GH's if we only provide one setting. Here we split the setting in to two - one for documents and one for comments and other things. Signed-off-by: Andrew Thornton art27@cantab.net Changes to index.js as per @silverwind Co-authored-by: silverwind <me@silverwind.io> Changes to docs as per @guillep2k Co-authored-by: guillep2k <18600385+guillep2k@users.noreply.github.com>
131 lines
3.1 KiB
Go
131 lines
3.1 KiB
Go
// Copyright 2014 The Gogs Authors. All rights reserved.
|
|
// Use of this source code is governed by a MIT-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package misc
|
|
|
|
import (
|
|
"net/http"
|
|
"strings"
|
|
|
|
"code.gitea.io/gitea/modules/context"
|
|
"code.gitea.io/gitea/modules/markup/markdown"
|
|
"code.gitea.io/gitea/modules/setting"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
"code.gitea.io/gitea/modules/util"
|
|
|
|
"mvdan.cc/xurls/v2"
|
|
)
|
|
|
|
// Markdown render markdown document to HTML
|
|
func Markdown(ctx *context.APIContext, form api.MarkdownOption) {
|
|
// swagger:operation POST /markdown miscellaneous renderMarkdown
|
|
// ---
|
|
// summary: Render a markdown document as HTML
|
|
// parameters:
|
|
// - name: body
|
|
// in: body
|
|
// schema:
|
|
// "$ref": "#/definitions/MarkdownOption"
|
|
// consumes:
|
|
// - application/json
|
|
// produces:
|
|
// - text/html
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/MarkdownRender"
|
|
// "422":
|
|
// "$ref": "#/responses/validationError"
|
|
|
|
if ctx.HasAPIError() {
|
|
ctx.Error(http.StatusUnprocessableEntity, "", ctx.GetErrMsg())
|
|
return
|
|
}
|
|
|
|
if len(form.Text) == 0 {
|
|
_, _ = ctx.Write([]byte(""))
|
|
return
|
|
}
|
|
|
|
switch form.Mode {
|
|
case "comment":
|
|
fallthrough
|
|
case "gfm":
|
|
md := []byte(form.Text)
|
|
urlPrefix := form.Context
|
|
meta := map[string]string{}
|
|
if !strings.HasPrefix(setting.AppSubURL+"/", urlPrefix) {
|
|
// check if urlPrefix is already set to a URL
|
|
linkRegex, _ := xurls.StrictMatchingScheme("https?://")
|
|
m := linkRegex.FindStringIndex(urlPrefix)
|
|
if m == nil {
|
|
urlPrefix = util.URLJoin(setting.AppURL, form.Context)
|
|
}
|
|
}
|
|
if ctx.Repo != nil && ctx.Repo.Repository != nil {
|
|
// "gfm" = Github Flavored Markdown - set this to render as a document
|
|
if form.Mode == "gfm" {
|
|
meta = ctx.Repo.Repository.ComposeDocumentMetas()
|
|
} else {
|
|
meta = ctx.Repo.Repository.ComposeMetas()
|
|
}
|
|
}
|
|
if form.Mode == "gfm" {
|
|
meta["mode"] = "document"
|
|
}
|
|
if form.Wiki {
|
|
_, err := ctx.Write([]byte(markdown.RenderWiki(md, urlPrefix, meta)))
|
|
if err != nil {
|
|
ctx.InternalServerError(err)
|
|
return
|
|
}
|
|
} else {
|
|
_, err := ctx.Write(markdown.Render(md, urlPrefix, meta))
|
|
if err != nil {
|
|
ctx.InternalServerError(err)
|
|
return
|
|
}
|
|
}
|
|
default:
|
|
_, err := ctx.Write(markdown.RenderRaw([]byte(form.Text), "", false))
|
|
if err != nil {
|
|
ctx.InternalServerError(err)
|
|
return
|
|
}
|
|
}
|
|
}
|
|
|
|
// MarkdownRaw render raw markdown HTML
|
|
func MarkdownRaw(ctx *context.APIContext) {
|
|
// swagger:operation POST /markdown/raw miscellaneous renderMarkdownRaw
|
|
// ---
|
|
// summary: Render raw markdown as HTML
|
|
// parameters:
|
|
// - name: body
|
|
// in: body
|
|
// description: Request body to render
|
|
// required: true
|
|
// schema:
|
|
// type: string
|
|
// consumes:
|
|
// - text/plain
|
|
// produces:
|
|
// - text/html
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/MarkdownRender"
|
|
// "422":
|
|
// "$ref": "#/responses/validationError"
|
|
|
|
body, err := ctx.Req.Body().Bytes()
|
|
if err != nil {
|
|
ctx.Error(http.StatusUnprocessableEntity, "", err)
|
|
return
|
|
}
|
|
_, err = ctx.Write(markdown.RenderRaw(body, "", false))
|
|
if err != nil {
|
|
ctx.InternalServerError(err)
|
|
return
|
|
}
|
|
}
|