mirror of
https://codeberg.org/forgejo/forgejo
synced 2024-12-05 02:54:46 +01:00
0d80af649a
* add init support of orgmode document type on file view and readme * fix imports * fix imports and readmeExist * fix imports order * fix format * remove unnecessary convert
200 lines
5.8 KiB
Go
200 lines
5.8 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 markdown
|
|
|
|
import (
|
|
"bytes"
|
|
"strings"
|
|
|
|
"code.gitea.io/gitea/modules/markup"
|
|
"code.gitea.io/gitea/modules/setting"
|
|
|
|
"github.com/russross/blackfriday"
|
|
)
|
|
|
|
// Renderer is a extended version of underlying render object.
|
|
type Renderer struct {
|
|
blackfriday.Renderer
|
|
URLPrefix string
|
|
IsWiki bool
|
|
}
|
|
|
|
// Link defines how formal links should be processed to produce corresponding HTML elements.
|
|
func (r *Renderer) Link(out *bytes.Buffer, link []byte, title []byte, content []byte) {
|
|
if len(link) > 0 && !markup.IsLink(link) {
|
|
if link[0] != '#' {
|
|
lnk := string(link)
|
|
if r.IsWiki {
|
|
lnk = markup.URLJoin("wiki", lnk)
|
|
}
|
|
mLink := markup.URLJoin(r.URLPrefix, lnk)
|
|
link = []byte(mLink)
|
|
}
|
|
}
|
|
|
|
r.Renderer.Link(out, link, title, content)
|
|
}
|
|
|
|
// List renders markdown bullet or digit lists to HTML
|
|
func (r *Renderer) List(out *bytes.Buffer, text func() bool, flags int) {
|
|
marker := out.Len()
|
|
if out.Len() > 0 {
|
|
out.WriteByte('\n')
|
|
}
|
|
|
|
if flags&blackfriday.LIST_TYPE_DEFINITION != 0 {
|
|
out.WriteString("<dl>")
|
|
} else if flags&blackfriday.LIST_TYPE_ORDERED != 0 {
|
|
out.WriteString("<ol class='ui list'>")
|
|
} else {
|
|
out.WriteString("<ul class='ui list'>")
|
|
}
|
|
if !text() {
|
|
out.Truncate(marker)
|
|
return
|
|
}
|
|
if flags&blackfriday.LIST_TYPE_DEFINITION != 0 {
|
|
out.WriteString("</dl>\n")
|
|
} else if flags&blackfriday.LIST_TYPE_ORDERED != 0 {
|
|
out.WriteString("</ol>\n")
|
|
} else {
|
|
out.WriteString("</ul>\n")
|
|
}
|
|
}
|
|
|
|
// ListItem defines how list items should be processed to produce corresponding HTML elements.
|
|
func (r *Renderer) ListItem(out *bytes.Buffer, text []byte, flags int) {
|
|
// Detect procedures to draw checkboxes.
|
|
prefix := ""
|
|
if bytes.HasPrefix(text, []byte("<p>")) {
|
|
prefix = "<p>"
|
|
}
|
|
switch {
|
|
case bytes.HasPrefix(text, []byte(prefix+"[ ] ")):
|
|
text = append([]byte(`<span class="ui fitted disabled checkbox"><input type="checkbox" disabled="disabled" /><label /></span>`), text[3+len(prefix):]...)
|
|
if prefix != "" {
|
|
text = bytes.Replace(text, []byte(prefix), []byte{}, 1)
|
|
}
|
|
case bytes.HasPrefix(text, []byte(prefix+"[x] ")):
|
|
text = append([]byte(`<span class="ui checked fitted disabled checkbox"><input type="checkbox" checked="" disabled="disabled" /><label /></span>`), text[3+len(prefix):]...)
|
|
if prefix != "" {
|
|
text = bytes.Replace(text, []byte(prefix), []byte{}, 1)
|
|
}
|
|
}
|
|
r.Renderer.ListItem(out, text, flags)
|
|
}
|
|
|
|
// Note: this section is for purpose of increase performance and
|
|
// reduce memory allocation at runtime since they are constant literals.
|
|
var (
|
|
svgSuffix = []byte(".svg")
|
|
svgSuffixWithMark = []byte(".svg?")
|
|
)
|
|
|
|
// Image defines how images should be processed to produce corresponding HTML elements.
|
|
func (r *Renderer) Image(out *bytes.Buffer, link []byte, title []byte, alt []byte) {
|
|
prefix := r.URLPrefix
|
|
if r.IsWiki {
|
|
prefix = markup.URLJoin(prefix, "wiki", "src")
|
|
}
|
|
prefix = strings.Replace(prefix, "/src/", "/raw/", 1)
|
|
if len(link) > 0 {
|
|
if markup.IsLink(link) {
|
|
// External link with .svg suffix usually means CI status.
|
|
// TODO: define a keyword to allow non-svg images render as external link.
|
|
if bytes.HasSuffix(link, svgSuffix) || bytes.Contains(link, svgSuffixWithMark) {
|
|
r.Renderer.Image(out, link, title, alt)
|
|
return
|
|
}
|
|
} else {
|
|
lnk := string(link)
|
|
lnk = markup.URLJoin(prefix, lnk)
|
|
lnk = strings.Replace(lnk, " ", "+", -1)
|
|
link = []byte(lnk)
|
|
}
|
|
}
|
|
|
|
out.WriteString(`<a href="`)
|
|
out.Write(link)
|
|
out.WriteString(`">`)
|
|
r.Renderer.Image(out, link, title, alt)
|
|
out.WriteString("</a>")
|
|
}
|
|
|
|
// RenderRaw renders Markdown to HTML without handling special links.
|
|
func RenderRaw(body []byte, urlPrefix string, wikiMarkdown bool) []byte {
|
|
htmlFlags := 0
|
|
htmlFlags |= blackfriday.HTML_SKIP_STYLE
|
|
htmlFlags |= blackfriday.HTML_OMIT_CONTENTS
|
|
renderer := &Renderer{
|
|
Renderer: blackfriday.HtmlRenderer(htmlFlags, "", ""),
|
|
URLPrefix: urlPrefix,
|
|
IsWiki: wikiMarkdown,
|
|
}
|
|
|
|
// set up the parser
|
|
extensions := 0
|
|
extensions |= blackfriday.EXTENSION_NO_INTRA_EMPHASIS
|
|
extensions |= blackfriday.EXTENSION_TABLES
|
|
extensions |= blackfriday.EXTENSION_FENCED_CODE
|
|
extensions |= blackfriday.EXTENSION_STRIKETHROUGH
|
|
extensions |= blackfriday.EXTENSION_NO_EMPTY_LINE_BEFORE_BLOCK
|
|
|
|
if setting.Markdown.EnableHardLineBreak {
|
|
extensions |= blackfriday.EXTENSION_HARD_LINE_BREAK
|
|
}
|
|
|
|
body = blackfriday.Markdown(body, renderer, extensions)
|
|
return body
|
|
}
|
|
|
|
var (
|
|
// MarkupName describes markup's name
|
|
MarkupName = "markdown"
|
|
)
|
|
|
|
func init() {
|
|
markup.RegisterParser(Parser{})
|
|
}
|
|
|
|
// Parser implements markup.Parser
|
|
type Parser struct {
|
|
}
|
|
|
|
// Name implements markup.Parser
|
|
func (Parser) Name() string {
|
|
return MarkupName
|
|
}
|
|
|
|
// Extensions implements markup.Parser
|
|
func (Parser) Extensions() []string {
|
|
return setting.Markdown.FileExtensions
|
|
}
|
|
|
|
// Render implements markup.Parser
|
|
func (Parser) Render(rawBytes []byte, urlPrefix string, metas map[string]string, isWiki bool) []byte {
|
|
return RenderRaw(rawBytes, urlPrefix, isWiki)
|
|
}
|
|
|
|
// Render renders Markdown to HTML with all specific handling stuff.
|
|
func Render(rawBytes []byte, urlPrefix string, metas map[string]string) []byte {
|
|
return markup.Render("a.md", rawBytes, urlPrefix, metas)
|
|
}
|
|
|
|
// RenderString renders Markdown to HTML with special links and returns string type.
|
|
func RenderString(raw, urlPrefix string, metas map[string]string) string {
|
|
return markup.RenderString("a.md", raw, urlPrefix, metas)
|
|
}
|
|
|
|
// RenderWiki renders markdown wiki page to HTML and return HTML string
|
|
func RenderWiki(rawBytes []byte, urlPrefix string, metas map[string]string) string {
|
|
return markup.RenderWiki("a.md", rawBytes, urlPrefix, metas)
|
|
}
|
|
|
|
// IsMarkdownFile reports whether name looks like a Markdown file
|
|
// based on its extension.
|
|
func IsMarkdownFile(name string) bool {
|
|
return markup.IsMarkupFile(name, MarkupName)
|
|
}
|