How can I render markdown to a golang template(html or tmpl) with blackfriday?

html go render markdown martini
AriesDevil picture AriesDevil · Apr 17, 2014 · Viewed 7.8k times · Source

I use the Martini framework,I have some markdown file and I want render it as HTML in tmpl/html template.

The markdown file like this:

title: A Test Demo
---
##ABC
> 123

And the template file like this:

<head>
  <title>{{name}}</title>
</head>

<body>
  <h2>{{abc}}</h2>
  <blockquote>
    <p>{{xyz}}</p>
  </blockquote>
</body>

I use the blackfriday parse the markdown and return []byte type,next step I wanna render the markdown file to this template and make each block to the right place,so how can I do this right way? Or use any way to do this better?

Answer

Intermernet picture Intermernet · Apr 17, 2014

One way to achieve this is to use the Funcs method to add a custom function to the template function map. See the Functions section of the template package docs for more info.

Given a template file page.html, some writer w (probably an http.ResponseWriter), and some struct p with a field Body containing data to be put into a template field, you can do something like:

Define a function:

func markDowner(args ...interface{}) template.HTML {
    s := blackfriday.MarkdownCommon([]byte(fmt.Sprintf("%s", args...)))
    return template.HTML(s)
}

Add it to the template function map:

tmpl := template.Must(template.New("page.html").Funcs(template.FuncMap{"markDown": markDowner}).ParseFiles("page.html"))

Execute the template:

err := tmpl.ExecuteTemplate(w, "page.html", p)
if err != nil {
    http.Error(w, err.Error(), http.StatusInternalServerError)
}

Then, in your template file, you can put something like:

{{.Body | markDown}}

And it will pass the Body through your markDowner function.

Playground

Related questions

Switch or if/elseif/else inside golang HTML templates

I have this struct : const ( paragraph_hypothesis = 1<<iota paragraph_attachment = 1<<iota paragraph_menu = 1<<iota ) type Paragraph struct { Type int // paragraph_hypothesis or paragraph_attachment or paragraph_menu } I want to display my paragraphs in …

Read More
How to range over slice of structs instead of struct of slices

Having played around with Go HTML templates a bit, all the examples I found for looping over objects in templates were passing structs of slices to the template, somewhat like in this example : type UserList struct { Id []int Name []string } …

Read More
How to compare the length of a list in html/template in golang?

I am trying to compare the length of a list in golang html/template. But it is loading forever in html. {{ $length := len .SearchData }} {{ if eq $length "0" }} Sorry. No matching results found {{ end }} Could anyone help me with this?

Read More