hnakayam/zenn_preview

Zenn预览专用Node.js环境镜像

镜像概述

本镜像基于Alpine Linux构建，集成Node.js环境，专为Zenn内容创作者提供本地预览功能。Zenn是一个面向技术创作者的内容发布平台，支持使用Markdown格式编写文章、书籍等内容。该镜像通过最小化的系统体积和完整的Node.js运行环境，帮助用户快速搭建本地预览环境，实时查看内容渲染效果。

核心功能与特性

• 轻量级基础：基于Alpine Linux，镜像体积小、启动速度快，资源占用低
• 完整Node.js环境：包含稳定版Node.js及npm，满足Zenn预览所需的依赖管理
• 开箱即用：预装Zenn CLI（如未包含，可通过npm快速安装），支持一键初始化预览项目
• 灵活挂载：支持本地内容目录挂载，实时同步修改并预览
• 跨平台兼容：可在Linux、macOS、Windows等系统的Docker环境中运行

使用场景与适用范围

• Zenn内容创作者：本地编写Markdown内容时实时预览渲染效果
• 内容格式验证：快速检查文章排版、代码块、图表等元素的显示效果
• 多环境一致性：确保不同设备上的预览效果与Zenn平台一致
• 轻量级开发：无需在本地系统安装Node.js及相关依赖，避免环境冲突

使用方法与配置说明

基本使用（docker run）

1. 拉取镜像

   bash
   docker pull docker.xuanyuan.run/[镜像名称]  # 请替换为实际镜像名称
   

2. 运行预览容器

   bash
   docker run -it --rm \
     -p 8000:8000 \
     -v $(pwd):/app \
     [镜像名称] \
     sh -c "cd /app && npx zenn preview"
   

   • 参数说明：
     • -p 8000:8000：映射容器内预览端口到本地（Zenn默认预览端口为8000）
     • -v $(pwd):/app：将当前目录挂载到容器内的/app目录（需确保当前目录为Zenn项目根目录）
     • npx zenn preview：启动Zenn预览服务

3. 访问预览页面：打开浏览器访问 http://localhost:8000 即可查看预览效果

Docker Compose配置

创建docker-compose.yml文件：

yaml
version: '3'
services:
  zenn-preview:
    image: docker.xuanyuan.run/[镜像名称]  # 替换为实际镜像名称
    ports:
      - "8000:8000"
    volumes:
      - ./:/app
    command: sh -c "cd /app && npx zenn preview"
    restart: unless-stopped

启动服务：

bash
docker-compose up

环境变量配置

示例（自定义端口）：

bash
docker run -it --rm \
  -p 3000:3000 \
  -v $(pwd):/app \
  -e PORT=3000 \
  [镜像名称] \
  sh -c "cd /app && npx zenn preview"

注意事项

• 确保本地目录包含Zenn项目必要文件（如articles/目录、book.json等）
• 首次运行时，npx zenn preview会自动安装依赖，可能需要几分钟时间
• 如需持久化依赖，可将node_modules目录单独挂载或在项目中添加package.json锁定依赖版本