Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

41 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

snake βš•οΈ

A TypeScript wrapper around Platane/snk that adds named custom color palettes β€” no forking, no Docker rebuild. Just pass ?palette=<name> in your outputs and get a themed contribution snake.

How to use ❓

Add this to your workflow file (e.g. .github/workflows/snake.yml):

name: generate snake animation

on:
  schedule:
    - cron: "0 */24 * * *"
  workflow_dispatch:
  push:
    branches:
      - main

jobs:
  generate:
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - name: generate snake svg
        uses: RS-SaJiD/snake@latest
        with:
          github_user_name: ${{ github.repository_owner }}
          outputs: |
            dist/snake.svg?palette=winter-dark
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: push to output branch
        uses: crazy-max/ghaction-github-pages@v3.1.0
        with:
          target_branch: snake-assets
          build_dir: dist
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Available palette names are listed in the gallery below. Replace winter-dark with any of them.

Snake Palette Gallery 🎨

Custom palettes (by me)

github-dark <-- (Platane's official, not mine)

github-dark

github-light <-- (Platane's official, not mine)

github-light

red-github-dark

red-github-dark

red-github-light

red-github-light

halloween-dark

halloween-dark

halloween-light

halloween-light

winter-dark

winter-dark

winter-light

winter-light

sakura-dark

sakura-dark

sakura-light

sakura-light

black-and-white-dark

black-and-white-dark

black-and-white-light

black-and-white-light

one-dark-pro

one-dark-pro

synthwave

synthwave

dracula

dracula

monokai

monokai

nord

nord

tokyo-night

tokyo-night

catppuccin

catppuccin

gruvbox

gruvbox

rose-pine

rose-pine

solarized-dark

solarized-dark

cyberpunk

cyberpunk

electric-violet

electric-violet


Other Platane official palettes

gitlab

gitlab-dark

gitlab-light

forgejo

forgejo-dark

forgejo-light

codeberg

codeberg-dark

codeberg-light

About

🐍 TypeScript wrapper for Platane/snk β€” named custom color palettes (πŸ§› dracula, πŸŒ† synthwave, ❄️ winter, πŸŽƒ halloween & more), no fork, no Docker

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages