半小时蹉了一个按路径预览markdown文档的小工具-markdown-live-preview

最近和团队在开发新的系统，但团队人比较少，并没有上什么沟通和管理的系统，只用了一个禅道来做BUG管理。禅道这个系统的文档系统，也实在是太过于垃圾，导致我们内部的文档都不怎么好管理。
我们基本都是用markdown来写文档，之前都是将文档在VSCODE里转成html再挂网站上给同事看，后来一时脑热，干脆弄一个小应用，将md文档放在根目录或是根目录的文件夹内，按指定的路径就能访问HTML。

这个需求相对简单，我用QODE，大概半小时就完成了整个的开发和测试、部署。还发布到了 https://github.com/cklx0719/markdown-live-preview，同时构建了docker镜像，放布到了hub.docker.com。

这个是用node.js做的一个简单的服务端，可以直接运行，也可以使用docker 一键部署。

直接使用 Docker Hub 镜像启动

docker run -d -p 3000:3000 -v $(pwd)/docs:/app/docs cklx0719/markdown-live-preview:latest

我是推荐直接使用docker部署的，非常简单。部署完后直接给个域名做反代，将md放在映射的宿主目录下，就能直接访问了。非常方便。

📝 自动将 Markdown 转换为 HTML
🎨 美观的 GitHub 风格样式
💻 代码高亮支持
🔄 实时渲染，无需重启
🚀 零配置，开箱即用
🔒 路径安全检查
🐳 Docker 容器化部署

使用docker compose

git clone https://github.com/cklx0719/markdown-live-preview

docker-compose up -d

Markdown 文件放入 docs 目录（会自动映射到容器内）

访问 http://localhost:3000/文件路径
例如：http://localhost:3000/pm/20251020

当然你也可以使用其他方法来运行。具体去 https://github.com/cklx0719/markdown-live-preview 看说明。

效果

比如我这个，md放在根目录，就直接访问了。

是不是很爽呢？

本文由 admin 创作，采用 知识共享署名4.0 国际许可协议进行许可。
本站文章除注明转载/出处外，均为本站原创或翻译，转载前请务必署名。