基于Go语言开发一个Markdown转HTML工具
作者:程序员爱钓鱼
这篇文章主要为大家详细介绍了如何基于Go语言开发一个Markdown转HTML工具,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
这个小工具可以把 .md
文件转换为 .html
文件,非常适合写笔记、博客或者快速预览 Markdown 内容。
案例目标
- 读取一个 Markdown 文件
- 使用开源库将 Markdown 转换为 HTML
- 将 HTML 输出到新文件中
所需库
我们用 goldmark 这个 Markdown 解析库,它轻量且高效。
安装:
go get github.com/yuin/goldmark
实现代码
package main import ( "fmt" "io/ioutil" "os" "path/filepath" "github.com/yuin/goldmark" ) func main() { if len(os.Args) < 2 { fmt.Println("用法: go run main.go <markdown文件>") return } mdFile := os.Args[1] // 读取Markdown文件 content, err := ioutil.ReadFile(mdFile) if err != nil { fmt.Printf("读取文件失败: %v\n", err) return } // 转换为HTML var htmlOutput []byte md := goldmark.New() var buf []byte htmlBuf := &buf err = md.Convert(content, htmlBuf) if err != nil { fmt.Printf("Markdown 转换失败: %v\n", err) return } htmlOutput = *htmlBuf // 生成HTML文件名 htmlFile := filepath.Base(mdFile[:len(mdFile)-len(filepath.Ext(mdFile))]) + ".html" // 写入HTML文件 err = ioutil.WriteFile(htmlFile, htmlOutput, 0644) if err != nil { fmt.Printf("写入HTML文件失败: %v\n", err) return } fmt.Printf("转换成功!输出文件: %s\n", htmlFile) }
使用方法
保存代码为 main.go
准备一个 test.md
文件,例如:
# Hello Markdown
这是一个 **Markdown 转 HTML** 的测试。
- 项目一
- 项目二
运行:
go run main.go test.md
会生成 test.html
,在浏览器里打开就能看到格式化的内容
方法补充
golang 自定义解析 markdown为 html
输出 HTML 模板内容如下
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Custom Markdown</title> <link rel="stylesheet" href="markdown.css" rel="external nofollow" /> </head> <body> {{ . }} </body> </html>
golang 程序如下
安装依赖 go get -u github.com/gomarkdown/markdown
package main import ( "bufio" "github.com/gomarkdown/markdown" "github.com/gomarkdown/markdown/ast" "github.com/gomarkdown/markdown/html" "html/template" "io" "log" "os" ) // return (ast.GoToNext, true) to tell html renderer to skip rendering this node // (because you've rendered it) func renderHookCodeBlock(w io.Writer, node ast.Node, entering bool) (ast.WalkStatus, bool) { // skip all nodes that are not CodeBlock nodes if _, ok := node.(*ast.CodeBlock); !ok { return ast.GoToNext, false } // custom rendering logic for ast.CodeBlock. By doing nothing it won't be // 写入自定义数据 w.Write([]byte(`<span>Hello World</span>`)) return ast.GoToNext, false } func main() { inputFile := "markdown.md" // 输入 md 文件 inputTemplateFile := "template.html" // 模板文件 outputFile := "markdown.html" // 输出 html 文件 opts := html.RendererOptions{ Flags: html.CommonFlags, RenderNodeHook: renderHookCodeBlock, // 设置自定义处理钩子 } renderer := html.NewRenderer(opts) // 打开 md 文件 fs, err := os.Open(inputFile) if err != nil { return } // 读取 md 内容 var md string scanner := bufio.NewScanner(fs) for scanner.Scan() { md += scanner.Text() + "\n" } if scanner.Err() != nil { log.Panicln(err) } // md to html html := markdown.ToHTML([]byte(md), nil, renderer) tp, err := template.ParseFiles(inputTemplateFile) if err != nil { return } // 写入输出文件 f, err := os.Create(outputFile) if err != nil { return } tp.Execute(f, template.HTML(html)) print(string(html)) }
到此这篇关于基于Go语言开发一个Markdown转HTML工具的文章就介绍到这了,更多相关Go Markdown转HTML内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!