Repolode
wei

wei/socialify

为 GitHub 项目生成可分享的社交预览图,支持实时数据、Logo、字体和背景图案。

Star
2,222
Fork
123
未关闭 Issue
13
最近提交
10天前

这是什么?

Socialify 为 GitHub 仓库生成项目展示图,可用于 README、社交平台分享,或作为仓库的社交预览图。用户选择仓库后,可以开关描述、作者、语言、Star、Fork、Issue 和 Pull Request 等元素,并通过自定义 Logo、字体、主题和背景图案调整外观。

生成结果有两种用法。图片接口返回的是实时图片,其中的数字会自动更新,适合放在 README 或 img 标签中。下载的 PNG、JPEG 或 WebP 图片则可用于需要上传图片文件的场景,例如 GitHub 的社交预览图设置。社区提供的 github-social-image 命令行工具可以一次为多个仓库上传图片。

项目基于 TypeScript 开发,采用 MIT 许可证,也支持使用 Docker 自行部署。

核心功能

  • 01为任意 GitHub 仓库生成项目展示图
  • 02可显示 Star、Fork、Issue、Pull Request 等实时数据
  • 03支持自定义 Logo、多种字体和背景图案
  • 04提供浅色和深色主题
  • 05可导出 PNG、JPEG 或 WebP 格式图片
  • 06支持使用 Docker 自行部署

适用场景

  • 在项目 README 中添加自动更新数据的横幅
  • 为 GitHub 仓库设置自定义社交预览图
  • 制作用于分享开源项目的品牌图片
  • 为多个仓库批量生成社交图片

快速上手

  1. 1

    将 .env.example 中列出的环境变量复制到 .env 文件中

  2. 2

    使用 docker-compose 启动应用

    docker-compose up -d
  3. 3

    或者直接构建并运行 Docker 镜像

    docker build -t socialify . && docker run -p 3000:3000 --env-file .env socialify

使用前须知

  • Socialify 仍在积极开发中,其设计和项目域名可能在不另行通知的情况下更改。

收录于专题

标签

常见问题

socialify 是什么?
为 GitHub 项目生成可分享的社交预览图,支持实时数据、Logo、字体和背景图案。 Socialify 为 GitHub 仓库生成项目展示图,可用于 README、社交平台分享,或作为仓库的社交预览图。用户选择仓库后,可以开关描述、作者、语言、Star、Fork、Issue 和 Pull Request 等元素,并通过自定义 Logo、字体、主题和背景图案调整外观。
socialify 可以免费使用吗?用的什么许可证?
socialify 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
socialify 还在维护吗?
活跃维护中。socialify 最近一次提交是在 2026年10月28日。
socialify 适合用来做什么?
在项目 README 中添加自动更新数据的横幅 为 GitHub 仓库设置自定义社交预览图 制作用于分享开源项目的品牌图片 为多个仓库批量生成社交图片
socialify 怎么安装和运行?
将 .env.example 中列出的环境变量复制到 .env 文件中 使用 docker-compose 启动应用: docker-compose up -d 或者直接构建并运行 Docker 镜像: docker build -t socialify . && docker run -p 3000:3000 --env-file .env socialify
在哪里获取 socialify?
源代码和安装说明在 GitHub 上:https://github.com/wei/socialify

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目