这个项目能做什么
markdown-viewer(二进制名称为 `mdv`)是一个以单个二进制文件分发的本地 Markdown 查看器和文件浏览器。它通过本地 HTTP 地址提供 Markdown 文件目录,并呈现双栏界面:左侧是可展开的常驻文件树,右侧是渲染后的内容。
渲染涵盖 GitHub Flavored Markdown,采用类似 GitHub 的样式、语法高亮代码块,并内置 Mermaid 图表支持。所有 UI 资源——CSS、JavaScript 和 HTML 模板——都嵌入在二进制文件中,因此无需外部依赖或单独的安装步骤。
安全默认设置包括目录遍历防护和针对 XSS 的 HTML 清理。可以从 UI 或使用 Ctrl+C 触发关闭。
安装方式是从发布页面下载适用于目标平台的 `mdv` 二进制文件,解压归档文件并将二进制文件放到 PATH 中。配置可以来自 `config.json` 文件或命令行标志,优先级如下(后者覆盖前者):内置默认值、`$HOME/.config/mdv/config.json`、当前工作目录中的 `config.json`、以 `MDV_` 为前缀的环境变量(例如 `MDV_PORT=9000`),最后是命令行标志。提供了 `config.json.example` 作为参考。
使用方式是在任何包含 Markdown 文件的目录中运行 `mdv`,然后在浏览器中打开 `http://127.0.0.1:8080`。标志包括 `-p, --port`(默认 8080)、`-o, --open` 用于自动启动浏览器、`-d, --dir` 用于设置要提供服务的根目录(默认 `.`),以及 `--version`。
从源代码构建需要 Go 1.24 或更高版本。Make 目标包括用于当前平台的 `build`、用于交叉编译的 `build-all`、用于生成 zip 归档的 `package`、`test` 和 `clean`。目标平台为 linux/amd64、linux/arm64、darwin/arm64 和 windows/amd64;macOS 构建仅支持 arm64,而 Intel Mac 可以从源代码构建。该仓库还包含 CHANGELOG.md 和 NOTICE.md,其中包含第三方许可证归属信息。
评论
0 人表达喜爱 · 满10人后显示 Deer Point
登录后参与讨论。