Go 项目里的 embed.FS 怎么做成可离线运行的 Markdown 预览器?
来源:17golang原创
时间:2026-07-22 16:33:55 153浏览 收藏
很多内部文档工具最后都会卡在“开发机能看,换台机器就缺文件”:Markdown 散在项目文件夹里,CSS 和插图又对应了好几个零散的相对路径。Go 的 embed.FS 可以把这些资源全部编进二进制,再用 net/http 起一个本地预览服务,交付时只带一个可执行文件就够了。
最小可行做法是:用
//go:embed收集site/下的页面资源,通过fs.Sub去掉目录前缀,再交给http.FileServer;构建后放到临时目录启动并用 curl 验收,才能确认它真的离线可用。
要点速览
embed.FS只负责把构建时存在的文件带进程序,不会替你转换 Markdown。fs.Sub(embedded, "site")能让 URL 根路径直接对应嵌入目录,避免多一层/site。- 静态服务要同时检查首页、CSS 和不存在路径,不能只看进程是否监听端口。
- 单二进制交付的边界是“预览已生成的 HTML”,编辑和 Markdown 渲染仍可继续扩展。
先把项目边界定成一个能验收的小工具
这个示例不做完整的 Markdown 编辑器,只解决一个很实用的交付问题:仓库里的 site/index.html、site/style.css 和插图被编译进 mdpreview,运行后在 127.0.0.1:8080 打开预览页。
目录保持简单,后面排查路径时不容易迷路:
mdpreview/
├── main.go
└── site/
├── index.html
└── style.css
这里的验收标准也先写清楚:没有外部网络时首页能返回 200,页面引用的 CSS 也能返回 200,访问随机路径返回 404,而不是把错误页面误当成首页。
用 embed.FS 把 Markdown 预览页编进二进制
先把已经生成好的 Markdown 转成的 HTML 放进 site/index.html。embed 的路径相对于当前 Go 源文件,匹配范围不能越过所在目录,因此把资源放在同级 site/ 最省事。
package main
import (
"embed"
"io/fs"
"log"
"net/http"
)
//go:embed site/*
var embedded embed.FS
func main() {
siteFS, err := fs.Sub(embedded, "site")
if err != nil {
log.Fatal(err)
}
handler := http.FileServer(http.FS(siteFS))
log.Println("markdown preview: http://127.0.0.1:8080")
if err := http.ListenAndServe("127.0.0.1:8080", handler); err != nil {
log.Fatal(err)
}
}
fs.Sub 是这里最容易漏掉的一步。没有它,文件服务器看到的是 site/index.html;有了它,浏览器请求 / 时才会在嵌入文件系统的根目录找到 index.html。这不是把文件复制到磁盘,而是在程序启动时读取二进制里的只读文件树。

site/index.html 只保留可验证的静态引用
离线 Markdown 预览 LOCAL PREVIEW
今天的发布说明
页面、样式和图片都来自同一个 Go 二进制。
路径统一写成以 / 开头的站点根路径。这样页面从 / 打开,或者以后挂到子路由下,都不会因为当前 URL 层级变化而丢掉样式。
把嵌入文件安全地交给 HTTP
http.FileServer 已经处理了目录索引、文件读取和不存在路径的兜底逻辑。小工具不需要先把资源解压到临时目录,也不要自己拼接用户输入去访问本地磁盘。
如果只想允许预览首页和 CSS,可以再包一层轻量路由,把公开范围锁在两个资源上:
func onlyPreview(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
switch r.URL.Path {
case "/", "/index.html", "/style.css":
next.ServeHTTP(w, r)
default:
http.NotFound(w, r)
}
})
}
再把启动处改成 http.ListenAndServe("127.0.0.1:8080", onlyPreview(handler)) 即可。绑定回环地址是本地预览的一个小但重要的边界:它不会主动把文档服务暴露到局域网。要给同事访问时,再明确改成监听指定网卡,并补上鉴权。

构建后从临时目录验证真正的单文件交付
不要在项目目录里直接运行来证明离线交付成功,那样即使嵌入失败,当前目录里的 site/ 也可能让问题看起来正常。用构建产物加临时目录做一次检查:
go build -o mdpreview .
tmpdir=$(mktemp -d)
cp mdpreview "$tmpdir/"
cd "$tmpdir"
./mdpreview > preview.log 2>&1 &
server_pid=$!
trap 'kill "$server_pid"' EXIT
curl -fsS -o index.html -w '%{http_code}\n' http://127.0.0.1:8080/
curl -fsS -o style.css -w '%{http_code}\n' http://127.0.0.1:8080/style.css
curl -sS -o missing.txt -w '%{http_code}\n' http://127.0.0.1:8080/missing.css
预期输出是 200、200、404。若首页是 404,优先检查 fs.Sub 的目录名和 //go:embed site/* 的相对位置;若首页成功但样式丢失,检查 HTML 的引用路径和资源是否真的放在 site/ 下。
几个容易把离线预览做坏的细节
- 把动态文件写回 embed.FS:
embed.FS是只读的。预览内容需要实时编辑时,应把渲染结果放在内存或另一个可写目录。 - 嵌入隐藏文件却没检查构建上下文:通配符只匹配构建时可见的文件,先用
go list或构建日志确认资源确实被打包。 - 直接监听所有网卡:本地文档不应默认暴露给同一网络的其他设备。
- 只用浏览器手工确认:至少把 200、200、404 三个请求写成脚本,后续改目录结构时才有回归保护。
相关问题
embed.FS 能直接渲染 Markdown 吗?
不能。它只负责嵌入和读取文件。可以在构建阶段把 Markdown 转成 HTML,也可以运行时用 Markdown 解析库把嵌入的 .md 读出来再渲染。
为什么要用 fs.Sub,而不是把 URL 写成 /site/?
两种方式都能工作,但 fs.Sub 可以把资源目录映射为站点根,更符合浏览器中的根路径引用,也能避免把项目内部目录名暴露给 URL。
单二进制适合做生产文档站吗?
适合小型内部文档、发布说明和离线演示;如果需要多人编辑、全文检索、权限和频繁更新,仍应使用专门的文档服务或外部存储。
验收结果应该落在三个状态上
这个小工具的价值不在代码量,而在交付边界清楚:构建时把 site/ 固定进二进制,服务端只暴露本地预览资源,验收脚本同时覆盖成功和失败路径。以后要接 Markdown 热更新、目录导航或搜索,也可以沿着“资源来源—渲染方式—HTTP 暴露范围”这三条线逐步扩展,而不用先推翻单文件启动方式。
-
502 收藏
-
502 收藏
-
Golang · Go问答 | 2天前 | go · 性能 · bufio · 日志处理 · 错误排查 · 分块读取 Go bufio.Scanner token too long Scanner.Buffer 大日志行501 收藏
-
501 收藏
-
501 收藏
-
112 收藏
-
193 收藏
-
391 收藏
-
488 收藏
-
Golang · Go问答 | 19小时前 | net/http · Go问答 · HTTP重试 · 请求体 · 接口稳定性 · net/http Go HTTP重试 Request.GetBody Request.Clone 请求体复用273 收藏
-
Golang · Go问答 | 19小时前 | go · 安全 · net/http · HTTP重定向 · 请求头 · 请求头 Authorization 安全边界 CheckRedirect Go HTTP重定向268 收藏
-
Golang · Go问答 | 20小时前 | 错误处理 · go · SQL · database/sql · 线上排查 · SCAN 查询结果 database/sql Go问答 rows.Next Rows.Err292 收藏
-
Golang · Go问答 | 20小时前 | 超时 · 错误处理 · go · Context · errors.Is Go context deadline exceeded WithCancelCause309 收藏
-
Golang · Go问答 | 21小时前 | JSON · 超时控制 · Go问答 · HTTP测试 · 接口验收 · JSON Go 超时 接口测试 httptest.NewServer 烟雾测试385 收藏
-
286 收藏
-
182 收藏
-
Golang · Go问答 | 1天前 | 标准库 · bufio · 网络协议 · Go问答 · 流式读取 · peek Go bufio.Reader 协议解析 Go问答 Discard UnreadByte414 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 485次学习