")) { - prefix = "
" - } - switch { - case bytes.HasPrefix(text, []byte(prefix+"[ ] ")): - text = append([]byte(``), text[3+len(prefix):]...) - if prefix != "" { - text = bytes.Replace(text, []byte(prefix), []byte{}, 1) +// RenderNode is a default renderer of a single node of a syntax tree. For +// block nodes it will be called twice: first time with entering=true, second +// time with entering=false, so that it could know when it's working on an open +// tag and when on close. It writes the result to w. +// +// The return value is a way to tell the calling walker to adjust its walk +// pattern: e.g. it can terminate the traversal by returning Terminate. Or it +// can ask the walker to skip a subtree of this node by returning SkipChildren. +// The typical behavior is to return GoToNext, which asks for the usual +// traversal to the next node. +func (r *Renderer) RenderNode(w io.Writer, node *blackfriday.Node, entering bool) blackfriday.WalkStatus { + switch node.Type { + case blackfriday.Image: + prefix := r.URLPrefix + if r.IsWiki { + prefix = util.URLJoin(prefix, "wiki", "raw") } - case bytes.HasPrefix(text, []byte(prefix+"[x] ")): - text = append([]byte(``), text[3+len(prefix):]...) - if prefix != "" { - text = bytes.Replace(text, []byte(prefix), []byte{}, 1) + prefix = strings.Replace(prefix, "/src/", "/media/", 1) + link := node.LinkData.Destination + if len(link) > 0 && !markup.IsLink(link) { + lnk := string(link) + lnk = util.URLJoin(prefix, lnk) + lnk = strings.Replace(lnk, " ", "+", -1) + link = []byte(lnk) + } + node.LinkData.Destination = link + // Render link around image only if parent is not link already + if node.Parent != nil && node.Parent.Type != blackfriday.Link { + if entering { + _, _ = w.Write([]byte(``)) + return r.Renderer.RenderNode(w, node, entering) + } + s := r.Renderer.RenderNode(w, node, entering) + _, _ = w.Write([]byte(``)) + return s + } + return r.Renderer.RenderNode(w, node, entering) + case blackfriday.Link: + // special case: this is not a link, a hash link or a mailto:, so it's a + // relative URL + link := node.LinkData.Destination + if len(link) > 0 && !markup.IsLink(link) && + link[0] != '#' && !bytes.HasPrefix(link, byteMailto) && + node.LinkData.Footnote == nil { + lnk := string(link) + if r.IsWiki { + lnk = util.URLJoin("wiki", lnk) + } + link = []byte(util.URLJoin(r.URLPrefix, lnk)) + } + node.LinkData.Destination = link + return r.Renderer.RenderNode(w, node, entering) + case blackfriday.Text: + isListItem := false + for n := node.Parent; n != nil; n = n.Parent { + if n.Type == blackfriday.Item { + isListItem = true + break + } + } + if isListItem { + text := node.Literal + switch { + case bytes.HasPrefix(text, []byte("[ ] ")): + _, _ = w.Write([]byte(``)) + text = text[3:] + case bytes.HasPrefix(text, []byte("[x] ")): + _, _ = w.Write([]byte(``)) + text = text[3:] + } + node.Literal = text } } - r.Renderer.ListItem(out, text, flags) -} - -// 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 = util.URLJoin(prefix, "wiki", "raw") - } - prefix = strings.Replace(prefix, "/src/", "/media/", 1) - if len(link) > 0 && !markup.IsLink(link) { - lnk := string(link) - lnk = util.URLJoin(prefix, lnk) - lnk = strings.Replace(lnk, " ", "+", -1) - link = []byte(lnk) - } - - // Put a link around it pointing to itself by default - out.WriteString(``) - r.Renderer.Image(out, link, title, alt) - out.WriteString("") + return r.Renderer.RenderNode(w, node, entering) } const ( blackfridayExtensions = 0 | - blackfriday.EXTENSION_NO_INTRA_EMPHASIS | - blackfriday.EXTENSION_TABLES | - blackfriday.EXTENSION_FENCED_CODE | - blackfriday.EXTENSION_STRIKETHROUGH | - blackfriday.EXTENSION_NO_EMPTY_LINE_BEFORE_BLOCK | - blackfriday.EXTENSION_DEFINITION_LISTS | - blackfriday.EXTENSION_FOOTNOTES | - blackfriday.EXTENSION_HEADER_IDS | - blackfriday.EXTENSION_AUTO_HEADER_IDS + blackfriday.NoIntraEmphasis | + blackfriday.Tables | + blackfriday.FencedCode | + blackfriday.Strikethrough | + blackfriday.NoEmptyLineBeforeBlock | + blackfriday.DefinitionLists | + blackfriday.Footnotes | + blackfriday.HeadingIDs | + blackfriday.AutoHeadingIDs blackfridayHTMLFlags = 0 | - blackfriday.HTML_SKIP_STYLE | - blackfriday.HTML_OMIT_CONTENTS | - blackfriday.HTML_USE_SMARTYPANTS + blackfriday.Smartypants ) // RenderRaw renders Markdown to HTML without handling special links. func RenderRaw(body []byte, urlPrefix string, wikiMarkdown bool) []byte { renderer := &Renderer{ - Renderer: blackfriday.HtmlRenderer(blackfridayHTMLFlags, "", ""), + Renderer: blackfriday.NewHTMLRenderer(blackfriday.HTMLRendererParameters{ + Flags: blackfridayHTMLFlags, + }), URLPrefix: urlPrefix, IsWiki: wikiMarkdown, } exts := blackfridayExtensions if setting.Markdown.EnableHardLineBreak { - exts |= blackfriday.EXTENSION_HARD_LINE_BREAK + exts |= blackfriday.HardLineBreak } - body = blackfriday.Markdown(body, renderer, exts) + body = blackfriday.Run(body, blackfriday.WithRenderer(renderer), blackfriday.WithExtensions(exts)) return markup.SanitizeBytes(body) } diff --git a/modules/markup/markdown/markdown_test.go b/modules/markup/markdown/markdown_test.go index 669b49367ee0a..b29f870ce5268 100644 --- a/modules/markup/markdown/markdown_test.go +++ b/modules/markup/markdown/markdown_test.go @@ -166,13 +166,13 @@ func testAnswers(baseURLContent, baseURLImages string) []string {
Here is a simple footnote,1 and here is a longer one.2
+Here is one with multiple paragraphs and code.
@@ -180,9 +180,9 @@ func testAnswers(baseURLContent, baseURLImages string) []string {{ my code }
Add as many paragraphs as you like.
-Add as many paragraphs as you like.
\nWikiPage\n
") } func TestRender_Images(t *testing.T) { @@ -45,10 +45,8 @@ func TestRender_Images(t *testing.T) { } url := "../../.images/src/02/train.jpg" - title := "Train" result := util.URLJoin(AppSubURL, url) - test( - "[[file:"+url+"]["+title+"]]", - `\n\n
\n")) - p.inline(&tmpBuf, data) - tmpBuf.WriteByte('\n') - tmpBuf.Write([]byte("
\n")) - tmpBlock.Write(tmpBuf.Bytes()) - - } else { - tmpBlock.WriteByte('\n') - tmpBlock.Write(data) - } - - } else { - marker = string(matches[2]) - syntax = string(matches[3]) - } - case isFootnoteDef(data): - matches := reFootnoteDef.FindSubmatch(data) - for i := range p.notes { - if p.notes[i].id == string(matches[1]) { - p.notes[i].def = string(matches[2]) - } - } - case isTable(data): - if inTable != true { - inTable = true - } - tmpBlock.Write(data) - tmpBlock.WriteByte('\n') - case IsKeyword(data): - continue - case isComment(data): - p.generateComment(&output, data) - case isHeadline(data): - p.generateHeadline(&output, data) - case isDefinitionList(data): - if inList != true { - listType = "dl" - inList = true - } - var work bytes.Buffer - flags := blackfriday.LIST_TYPE_DEFINITION - matches := reDefinitionList.FindSubmatch(data) - flags |= blackfriday.LIST_TYPE_TERM - p.inline(&work, matches[1]) - p.r.ListItem(&tmpBlock, work.Bytes(), flags) - work.Reset() - flags &= ^blackfriday.LIST_TYPE_TERM - p.inline(&work, matches[2]) - p.r.ListItem(&tmpBlock, work.Bytes(), flags) - case isUnorderedList(data): - if inList != true { - listType = "ul" - inList = true - } - matches := reUnorderedList.FindSubmatch(data) - var work bytes.Buffer - p.inline(&work, matches[2]) - p.r.ListItem(&tmpBlock, work.Bytes(), 0) - case isOrderedList(data): - if inList != true { - listType = "ol" - inList = true - } - matches := reOrderedList.FindSubmatch(data) - var work bytes.Buffer - tmpBlock.WriteString("\n")
- inFixedWidthArea = true
- }
- matches := reExampleLine.FindSubmatch(data)
- tmpBlock.Write(matches[1])
- tmpBlock.WriteString("\n")
- break
- default:
- if inParagraph == false {
- inParagraph = true
- if inFixedWidthArea == true {
- if tmpBlock.Len() > 0 {
- tmpBlock.WriteString("")
- output.Write(tmpBlock.Bytes())
- }
- inFixedWidthArea = false
- tmpBlock.Reset()
- }
- }
- tmpBlock.Write(data)
- tmpBlock.WriteByte('\n')
- }
- }
-
- if len(tmpBlock.Bytes()) > 0 {
- if inParagraph == true {
- p.generateParagraph(&output, tmpBlock.Bytes()[:len(tmpBlock.Bytes())-1])
- } else if inFixedWidthArea == true {
- tmpBlock.WriteString("\n")
- output.Write(tmpBlock.Bytes())
- }
- }
-
- // Writing footnote def. list
- if len(p.notes) > 0 {
- flags := blackfriday.LIST_ITEM_BEGINNING_OF_LIST
- p.r.Footnotes(&output, func() bool {
- for i := range p.notes {
- p.r.FootnoteItem(&output, []byte(p.notes[i].id), []byte(p.notes[i].def), flags)
- }
- return true
- })
- }
-
- return output.Bytes()
-}
-
-// Org Syntax has been broken up into 4 distinct sections based on
-// the org-syntax draft (http://orgmode.org/worg/dev/org-syntax.html):
-// - Headlines
-// - Greater Elements
-// - Elements
-// - Objects
-
-// Headlines
-func isHeadline(data []byte) bool {
- if !charMatches(data[0], '*') {
- return false
- }
- level := 0
- for level < 6 && charMatches(data[level], '*') {
- level++
- }
- return charMatches(data[level], ' ')
-}
-
-func (p *parser) generateHeadline(out *bytes.Buffer, data []byte) {
- level := 1
- status := ""
- priority := ""
-
- for level < 6 && data[level] == '*' {
- level++
- }
-
- start := skipChar(data, level, ' ')
-
- data = data[start:]
- i := 0
-
- // Check if has a status so it can be rendered as a separate span that can be hidden or
- // modified with CSS classes
- if hasStatus(data[i:4]) {
- status = string(data[i:4])
- i += 5 // one extra character for the next whitespace
- }
-
- // Check if the next byte is a priority marker
- if data[i] == '[' && hasPriority(data[i+1]) {
- priority = string(data[i+1])
- i += 4 // for "[c]" + ' '
- }
-
- tags, tagsFound := findTags(data, i)
-
- headlineID := sanitized_anchor_name.Create(string(data[i:]))
-
- generate := func() bool {
- dataEnd := len(data)
- if tagsFound > 0 {
- dataEnd = tagsFound
- }
-
- headline := bytes.TrimRight(data[i:dataEnd], " \t")
-
- if status != "" {
- out.WriteString("" + status + "")
- out.WriteByte(' ')
- }
-
- if priority != "" {
- out.WriteString("[" + priority + "]")
- out.WriteByte(' ')
- }
-
- p.inline(out, headline)
-
- if tagsFound > 0 {
- for _, tag := range tags {
- out.WriteByte(' ')
- out.WriteString("")
- out.WriteByte(' ')
- }
- }
- return true
- }
-
- p.r.Header(out, generate, level, headlineID)
-}
-
-func hasStatus(data []byte) bool {
- return bytes.Contains(data, []byte("TODO")) || bytes.Contains(data, []byte("DONE"))
-}
-
-func hasPriority(char byte) bool {
- return (charMatches(char, 'A') || charMatches(char, 'B') || charMatches(char, 'C'))
-}
-
-func findTags(data []byte, start int) ([]string, int) {
- tags := []string{}
- tagOpener := 0
- tagMarker := tagOpener
- for tIdx := start; tIdx < len(data); tIdx++ {
- if tagMarker > 0 && data[tIdx] == ':' {
- tags = append(tags, string(data[tagMarker+1:tIdx]))
- tagMarker = tIdx
- }
- if data[tIdx] == ':' && tagOpener == 0 && data[tIdx-1] == ' ' {
- tagMarker = tIdx
- tagOpener = tIdx
- }
- }
- return tags, tagOpener
-}
-
-// Greater Elements
-// ~~ Definition Lists
-var reDefinitionList = regexp.MustCompile(`^\s*-\s+(.+?)\s+::\s+(.*)`)
-
-func isDefinitionList(data []byte) bool {
- return reDefinitionList.Match(data)
-}
-
-// ~~ Example lines
-var reExampleLine = regexp.MustCompile(`^\s*:\s(\s*.*)|^\s*:$`)
-
-func isExampleLine(data []byte) bool {
- return reExampleLine.Match(data)
-}
-
-// ~~ Ordered Lists
-var reOrderedList = regexp.MustCompile(`^(\s*)\d+\.\s+\[?@?(\d*)\]?(.+)`)
-
-func isOrderedList(data []byte) bool {
- return reOrderedList.Match(data)
-}
-
-// ~~ Unordered Lists
-var reUnorderedList = regexp.MustCompile(`^(\s*)[-\+]\s+(.+)`)
-
-func isUnorderedList(data []byte) bool {
- return reUnorderedList.Match(data)
-}
-
-// ~~ Tables
-var reTableHeaders = regexp.MustCompile(`^[|+-]*$`)
-
-func isTable(data []byte) bool {
- return charMatches(data[0], '|')
-}
-
-func (p *parser) generateTable(output *bytes.Buffer, data []byte) {
- var table bytes.Buffer
- rows := bytes.Split(bytes.Trim(data, "\n"), []byte("\n"))
- hasTableHeaders := len(rows) > 1
- if len(rows) > 1 {
- hasTableHeaders = reTableHeaders.Match(rows[1])
- }
- tbodySet := false
-
- for idx, row := range rows {
- var rowBuff bytes.Buffer
- if hasTableHeaders && idx == 0 {
- table.WriteString("")
- for _, cell := range bytes.Split(row[1:len(row)-1], []byte("|")) {
- p.r.TableHeaderCell(&rowBuff, bytes.Trim(cell, " \t"), 0)
- }
- p.r.TableRow(&table, rowBuff.Bytes())
- table.WriteString("\n")
- } else if hasTableHeaders && idx == 1 {
- continue
- } else {
- if !tbodySet {
- table.WriteString("")
- tbodySet = true
- }
- if !reTableHeaders.Match(row) {
- for _, cell := range bytes.Split(row[1:len(row)-1], []byte("|")) {
- var cellBuff bytes.Buffer
- p.inline(&cellBuff, bytes.Trim(cell, " \t"))
- p.r.TableCell(&rowBuff, cellBuff.Bytes(), 0)
- }
- p.r.TableRow(&table, rowBuff.Bytes())
- }
- if tbodySet && idx == len(rows)-1 {
- table.WriteString("\n")
- tbodySet = false
- }
- }
- }
-
- output.WriteString("\n", ""},
+ "=": []string{``, ""},
+ "_": []string{``, ""},
+ "_{}": []string{"", ""},
+ "^{}": []string{"", ""},
+}
+
+var listTags = map[string][]string{
+ "unordered": []string{"\n%s\n\n` + "\n" + content + "\n\n") + case name == "EXPORT" && len(b.Parameters) >= 1 && strings.ToLower(b.Parameters[0]) == "html": + w.WriteString(content + "\n") + case name == "QUOTE": + w.WriteString("
\n" + content + "\n") + case name == "CENTER": + w.WriteString(`
[%s]`, s.Content))
+}
+
+func (w *HTMLWriter) WriteLineBreak(l LineBreak) {
+ w.WriteString(strings.Repeat("\n", l.Count))
+}
+
+func (w *HTMLWriter) WriteExplicitLineBreak(l ExplicitLineBreak) {
+ w.WriteString("") + if _, ok := p.Children[0].(LineBreak); !ok { + w.WriteString("\n") + } + WriteNodes(w, p.Children...) + w.WriteString("\n
\n") +} + +func (w *HTMLWriter) WriteExample(e Example) { + w.WriteString(`` + "\n")
+ if len(e.Children) != 0 {
+ for _, n := range e.Children {
+ WriteNodes(w, n)
+ w.WriteString("\n")
+ }
+ }
+ w.WriteString("\n")
+}
+
+func (w *HTMLWriter) WriteHorizontalRule(h HorizontalRule) {
+ w.WriteString("