mbentley/grip

mbentley/grip Docker镜像文档

镜像概述

mbentley/grip是一个基于mbentley/alpine:latest构建的Docker镜像，用于运行grip工具，提供GitHub Markdown的本地预览功能。grip能够模拟GitHub的Markdown渲染风格，帮助用户在本地编写文档时实时查看最终在GitHub上的显示效果。

核心功能与特性

• GitHub Markdown预览：模拟GitHub的Markdown渲染引擎，提供与GitHub一致的显示效果
• 轻量级基础：基于Alpine Linux构建，镜像体积小，资源占用低
• 本地文件支持：可直接预览本地Markdown文件，无需上传至GitHub
• 便捷部署：通过Docker容器化部署，简化环境配置，跨平台可用

使用场景

• 开发者在本地编写GitHub仓库的README.md或其他Markdown文档时，实时预览渲染效果
• 需要验证Markdown语法在GitHub环境下显示效果的场景
• 团队协作中，本地共享Markdown文档预览效果

使用方法

拉取镜像

使用以下命令拉取最新版本的mbentley/grip镜像：

bash
docker pull docker.xuanyuan.run/mbentley/grip

运行示例

以下示例展示如何运行容器并预览本地Markdown文件：

bash
docker run -it --rm -p 8080:8080 \
  -v ${PWD}:/data \
  -v ~/.grip:/.grip \
  docker.xuanyuan.run/mbentley/grip \
  --context=username/repo README.md 0.0.0.0:8080

参数说明：

• -it：以交互模式运行容器
• --rm：容器退出后自动删除，避免残留容器文件
• -p 8080:8080：端口映射，将容器内的8080端口映射到主机的8080端口，用于访问预览页面
• -v ${PWD}:/data：挂载当前工作目录到容器内的/data目录，用于读取本地Markdown文件（${PWD}表示主机当前目录）
• -v ~/.grip:/.grip：挂载主机的grip配置目录到容器内的/.grip，保存grip的配置和缓存
• --context=username/repo：指定GitHub仓库上下文（替换为实际的GitHub用户名/仓库名），用于模拟仓库内的相对链接和渲染
• README.md：要预览的Markdown文件名（需位于挂载的/data目录下，即主机当前目录）
• 0.0.0.0:8080：指定grip服务监听的地址和端口（0.0.0.0表示允许外部访问，8080为端口）

访问预览

运行容器后，通过浏览器访问 http://localhost:8080 即可查看README.md的GitHub风格预览效果。