🎨 Gridist (grid + gist)

Transform your GitHub profile into an art gallery with smart image grids! Perfect for developers who want their profile to stand out.

Tip

Please check this example

🌟 What is Gridist?

Gridist is a powerful tool that transforms your images into eye-catching grid layouts for your GitHub profile. Whether you want to showcase your artwork, display your project screenshots, or just make your profile more visually appealing, Gridist makes it simple and elegant.

✨ Features

• 🖼️ Smart Image Splitting: Automatically splits images into perfectly sized grid pieces for GitHub profile display
• 🎬 GIF Support: Works with both static PNG images and animated GIFs
• 🔄 GitHub Integration: Seamlessly uploads split images to GitHub Gists with just one command
• 🎯 Profile Ready: Creates grid layouts that are perfectly sized for GitHub profile pinned gists
• 🖥️ Simple CLI: User-friendly command line interface with intuitive commands

📦 Installation

Choose your preferred installation method:

# Using Homebrew
brew install kiwamizamurai/tap/gridist

# Using Cargo
cargo install gridist

# Using Binary (macOS/Linux/Windows)
# 1. Download the latest binary from:
#    https://github.com/kiwamizamurai/gridist/releases
# 2. Extract and add to your PATH

🚀 Usage

CLI Commands

Gridist provides two main commands: upload for splitting and uploading images, and manage for managing your uploaded gists.

gridist upload /images/your-image.png -t $(gh auth token)

gridist manage -t $(gh auth token)

🎮 CLI Reference

Global options:

• -d, --debug: Enable debug logging

Upload command options:

• FILE: Path to the image file (PNG or GIF)
• -t, --token: GitHub personal access token (can also be set via GITHUB_TOKEN environment variable)

Manage command options:

• -t, --token: GitHub personal access token (can also be set via GITHUB_TOKEN environment variable)

GitHub Actions Integration

🚧 Work in Progress

To use Gridist with GitHub Actions, follow these steps:

1. Create a .github/workflows/ directory in your repository
2. Create a new workflow file (e.g., profile-grid.yml) with the following content:

name: Update Profile Grid

on:
  # Run when images are updated
  push:
    paths:
      - 'images/**'  # When files in the images/ directory change
  # Manual trigger option
  workflow_dispatch:

jobs:
  update-grid:
    uses: kiwamizamurai/gridist/.github/workflows/gridist.yml@main
    with:
      image_path: 'images/profile.png'  # Path to the image you want to split
    secrets:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

3. Create an images/ directory in your repository and place your image there
4. The workflow will automatically run when you push image changes
5. You can also manually trigger the workflow from the GitHub Actions tab

🤝 Contributing

PRs welcome! Check out our contribution guidelines.

🔗 References

• GitHub Gist Image Upload Reference
• GitHub Gist API Reference