Editor preview support for external renderers

modules/markup/renderer.go

@@ -283,6 +283,11 @@ type ErrUnsupportedRenderExtension struct {
 	Extension string
 }
 
+func IsErrUnsupportedRenderExtension(err error) bool {
+	_, ok := err.(ErrUnsupportedRenderExtension)
+	return ok
+}
+
 func (err ErrUnsupportedRenderExtension) Error() string {
 	return fmt.Sprintf("Unsupported render extension: %s", err.Extension)
 }
@@ -317,3 +322,15 @@ func IsMarkupFile(name, markup string) bool {
 	}
 	return false
 }
+
+func PreviewableExtensions() []string {
+	extensions := []string{}
+
+	for _, fileMode := range setting.Repository.Editor.PreviewableFileModes {
+		if renderer, ok := renderers[fileMode]; ok {
+			extensions = append(extensions, renderer.Extensions()...)
+		}
+	}
+
+	return extensions
+}

modules/structs/miscellaneous.go

@@ -15,13 +15,41 @@ type SearchError struct {
 	Error string `json:"error"`
 }
 
+// MarkupOption markup options
+type MarkupOption struct {
+	// Text markup to render
+	//
+	// in: body
+	Text string
+	// Mode to render (comment, gfm, markdown, file)
+	//
+	// in: body
+	Mode string
+	// Context to render
+	//
+	// in: body
+	Context string
+	// Is it a wiki page ?
+	//
+	// in: body
+	Wiki bool
+	// File path for detecting extension in file mode
+	//
+	// in: body
+	FilePath string
+}
+
+// MarkupRender is a rendered markup document
+// swagger:response MarkupRender
+type MarkupRender string
+
 // MarkdownOption markdown options
 type MarkdownOption struct {
 	// Text markdown to render
 	//
 	// in: body
 	Text string
-	// Mode to render
+	// Mode to render (comment, gfm, markdown)
 	//
 	// in: body
 	Mode string

routers/api/v1/api.go

@@ -711,6 +711,7 @@ func Routes(ctx gocontext.Context) *web.Route {
 			})
 		}
 		m.Get("/signing-key.gpg", misc.SigningKey)
+		m.Post("/markup", bind(api.MarkupOption{}), misc.Markup)
 		m.Post("/markdown", bind(api.MarkdownOption{}), misc.Markdown)
 		m.Post("/markdown/raw", misc.MarkdownRaw)
 		m.Group("/settings", func() {
@@ -1027,6 +1028,7 @@ func Routes(ctx gocontext.Context) *web.Route {
 						Patch(reqToken(auth_model.AccessTokenScopeRepo), reqRepoWriter(unit.TypeIssues, unit.TypePullRequests), bind(api.EditLabelOption{}), repo.EditLabel).
 						Delete(reqToken(auth_model.AccessTokenScopeRepo), reqRepoWriter(unit.TypeIssues, unit.TypePullRequests), repo.DeleteLabel)
 				})
+				m.Post("/markup", reqToken(auth_model.AccessTokenScopeRepo), bind(api.MarkupOption{}), misc.Markup)
 				m.Post("/markdown", reqToken(auth_model.AccessTokenScopeRepo), bind(api.MarkdownOption{}), misc.Markdown)
 				m.Post("/markdown/raw", reqToken(auth_model.AccessTokenScopeRepo), misc.MarkdownRaw)
 				m.Group("/milestones", func() {