基于Go语言开发一个Markdown转HTML工具

更新时间：2025年09月10日 08:18:05 作者：程序员爱钓鱼

这篇文章主要为大家详细介绍了如何基于Go语言开发一个Markdown转HTML工具,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下

案例目标

读取一个 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内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Go Java 算法之字符串解码示例详解
这篇文章主要为大家介绍了Go Java 算法之字符串解码示例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-08-08
Golang 处理浮点数遇到的精度问题(使用decimal)
本文主要介绍了Golang 处理浮点数遇到的精度问题，不使用decimal会出大问题，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-02-02
Go语言Elasticsearch数据清理工具思路详解
这篇文章主要介绍了Go语言Elasticsearch数据清理工具思路详解,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2021-10-10
Go中Goroutines轻量级并发的特性及效率探究
这篇文章主要为大家介绍了Go中Goroutines轻量级并发的特性及效率探究,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2023-12-12
GoLang与Java各自生成grpc代码流程介绍
这篇文章主要介绍了GoLang与Java各自生成grpc代码流程，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习吧
2023-03-03
Golang实现文件夹的创建与删除的方法详解
这篇文章主要介绍了如何利用Go语言实现对文件夹的常用操作：创建于删除。文中的示例代码讲解详细，感兴趣的小伙伴可以跟随小编一起学习一下
2022-05-05
一文带你了解GO语言中方法的应用
GO 语言中的方法实际上和函数是类似的,只不过在函数的基础上多了一个参数,这篇文章主要为大家介绍一下GO语言中方法的应用,需要的可以参考下
2023-09-09
Windows上安装Go并配置环境变量(图文步骤)
开始使用Go创建应用程序之前,需要设置开发环境,本文主要介绍了Windows上安装Go并配置环境变量,具有一定的参考价值,感兴趣的可以了解一下
2023-08-08
golang int64转int的方法
这篇文章主要介绍了golang int64转int,本文给大家提供两种方法，将 golang int64 转换为golang int，结合实例代码给大家分享转换方法，需要的朋友可以参考下
2023-01-01
golang中channel+error来做异步错误处理有多香
官方推荐golang中错误处理当做值处理，既然是值那就可以在channel中传输，这篇文章主要介绍了golang 错误处理channel+error真的香,需要的朋友可以参考下
2023-01-01