mirror of
https://github.com/go-gitea/gitea.git
synced 2024-12-15 09:47:39 +08:00
3f9c3e7bc3
There were too many patches to the Render system, it's really difficult to make further improvements. This PR clears the legacy problems and fix TODOs. 1. Rename `RenderContext.Type` to `RenderContext.MarkupType` to clarify its usage. 2. Use `ContentMode` to replace `meta["mode"]` and `IsWiki`, to clarify the rendering behaviors. 3. Use "wiki" mode instead of "mode=gfm + wiki=true" 4. Merge `renderByType` and `renderByFile` 5. Add more comments ---- The problem of "mode=document": in many cases it is not set, so many non-comment places use comment's hard line break incorrectly
109 lines
2.7 KiB
Go
109 lines
2.7 KiB
Go
// Copyright 2014 The Gogs Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package misc
|
|
|
|
import (
|
|
"net/http"
|
|
|
|
"code.gitea.io/gitea/modules/markup"
|
|
"code.gitea.io/gitea/modules/markup/markdown"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
"code.gitea.io/gitea/modules/util"
|
|
"code.gitea.io/gitea/modules/web"
|
|
"code.gitea.io/gitea/routers/common"
|
|
"code.gitea.io/gitea/services/context"
|
|
)
|
|
|
|
// Markup render markup document to HTML
|
|
func Markup(ctx *context.APIContext) {
|
|
// swagger:operation POST /markup miscellaneous renderMarkup
|
|
// ---
|
|
// summary: Render a markup document as HTML
|
|
// parameters:
|
|
// - name: body
|
|
// in: body
|
|
// schema:
|
|
// "$ref": "#/definitions/MarkupOption"
|
|
// consumes:
|
|
// - application/json
|
|
// produces:
|
|
// - text/html
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/MarkupRender"
|
|
// "422":
|
|
// "$ref": "#/responses/validationError"
|
|
|
|
form := web.GetForm(ctx).(*api.MarkupOption)
|
|
|
|
if ctx.HasAPIError() {
|
|
ctx.Error(http.StatusUnprocessableEntity, "", ctx.GetErrMsg())
|
|
return
|
|
}
|
|
|
|
mode := util.Iif(form.Wiki, "wiki", form.Mode) //nolint:staticcheck
|
|
common.RenderMarkup(ctx.Base, ctx.Repo, mode, form.Text, form.Context, form.FilePath)
|
|
}
|
|
|
|
// Markdown render markdown document to HTML
|
|
func Markdown(ctx *context.APIContext) {
|
|
// 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"
|
|
|
|
form := web.GetForm(ctx).(*api.MarkdownOption)
|
|
|
|
if ctx.HasAPIError() {
|
|
ctx.Error(http.StatusUnprocessableEntity, "", ctx.GetErrMsg())
|
|
return
|
|
}
|
|
|
|
mode := util.Iif(form.Wiki, "wiki", form.Mode) //nolint:staticcheck
|
|
common.RenderMarkup(ctx.Base, ctx.Repo, mode, form.Text, form.Context, "")
|
|
}
|
|
|
|
// 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"
|
|
defer ctx.Req.Body.Close()
|
|
if err := markdown.RenderRaw(&markup.RenderContext{
|
|
Ctx: ctx,
|
|
}, ctx.Req.Body, ctx.Resp); err != nil {
|
|
ctx.InternalServerError(err)
|
|
return
|
|
}
|
|
}
|