https://github.com/shaybox/github-socialify-preview

Upload GitHub repository Socialify preview images
https://github.com/shaybox/github-socialify-preview

github-social github-social-preview social-image social-preview socialify

Last synced: about 1 year ago
JSON representation

Upload GitHub repository Socialify preview images

• Host: GitHub
• URL: https://github.com/shaybox/github-socialify-preview
• Owner: ShayBox
• License: mit
• Created: 2024-02-06T02:56:29.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-02-06T04:32:36.000Z (about 2 years ago)
• Last Synced: 2025-01-08T12:48:53.207Z (over 1 year ago)
• Topics: github-social, github-social-preview, social-image, social-preview, socialify
• Language: Rust
• Homepage: https://crates.io/crates/github-socialify-preview
• Size: 21.5 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# GitHub Socialify Preview

Upload GitHub repository Socialify preview images

Based on [mheap/github-social-image](https://github.com/mheap/github-social-image)

## Command Line

`$ github-socialify-preview --help`

```

Upload GitHub repository Socialify preview images

Usage: github-socialify-preview.exe [OPTIONS] --repo 

Options:

  -r, --repo                 GitHub Repository (Example: ShayBox/GitHub-Social-Preview)

  -t, --theme               Socialify Theme [possible values: light, dark, auto]

  -f, --font                 Socialify Font [possible values: inter, bitter, raleway, rokkitt, source-code-pro, ko-ho, jost]

  -p, --pattern           Socialify Background Pattern [possible values: signal, charlie-brown, formal-invitation, plus, circuit-board, overlapping-hexagons, brick-wall, floating-cogs, diagonal-stripes, solid]

  -l, --logo                 Socialify SVG Logo (Image URL or Data URI)

      --owner                      Socialify Show Owner Name

      --language                   Socialify Show Language

      --stargazers                 Socialify Show Stars Count

      --forks                      Socialify Show Forks Count

      --issues                     Socialify Show Issues Count

      --pulls                      Socialify Show Pull Requests Count

  -d, --description   Socialify Show Description

  -h, --help                       Print help

  -V, --version                    Print version

```

## Installation

[Cargo]/[Crate]: `$ cargo install github-socialify-preview`  

[GitHub Latest Release (Portable)](https://github.com/ShayBox/GitHub-Socialify-Preview/releases/latest)

[Cargo]: https://rustup.rs

[Crate]: https://crates.io/crates/github-socialify-preview