Profilescape

Open source · MIT · Actively maintained

Your GitHub profile, rendered as a landscape

Profilescape turns your contributions, languages and projects into a matching set of animated SVG cards for your profile README. It runs as a GitHub Action in your own repository with your own token: no rate limits, no servers, private contributions optional.

Get started GitHub
  • 8 cards
  • 14 themes
  • Dark + light variants
  • 0 runtime dependencies
3D contribution landscape of a demo profile
Rendered live in your browser. Try a theme:
Customize

Playground

Design your cards

Pick cards, a theme and options. The preview renders instantly in your browser and the workflow below updates as you go. The URL keeps your setup, so you can share it.

Live preview

Preview uses demo data - your real data is rendered by the Action in your repo.

Your setup

Save as .github/workflows/profilescape.yml in your profile repository (the one named after your username). Only settings that differ from the defaults are included.

.github/workflows/profilescape.yml

Quick start

Live on your profile in three steps

About five minutes, no servers and no secrets required.

  1. Create your profile repository

    GitHub shows the README of the public repository named exactly like your username, for example octocat/octocat. Or start from the template, which already has the workflow and markers.

    Use the template

  2. Add the workflow

    Copy the workflow from the playground into .github/workflows/profilescape.yml, or start from this minimal one:

    name: Profilescape
on:
  schedule:
    - cron: "23 4 * * *" # every day
  workflow_dispatch:
permissions:
  contents: write
jobs:
  cards:
    runs-on: ubuntu-latest
    steps:
      - uses: chethandvg/profilescape@v1
        with:
          readme: README.md

  3. Add the markers and run it

    Put <!-- profilescape:start --> and <!-- profilescape:end --> in your README, then open Actions → Profilescape → Run workflow. Your cards appear in about a minute and refresh every day.

Private contributions

The default workflow token sees public activity. Add a fine-grained personal access token (All repositories; read-only Contents and Metadata) as the PROFILESCAPE_TOKEN secret to include private repositories and contributions. It is only ever used to read.

Prefer the terminal?

The CLI renders the same cards into a profilescape folder. Try it without a token:

npx github:chethandvg/profilescape --demo --cards all

Standalone actions

Want just one card? Each of these runs the same engine with a different default card set.

  • Every card

    Self-hosted GitHub profile README cards: 3D contribution graph, stats, top languages, repo cards. Your token, no servers.

    Default cards: Stats, 3D contribution landscape, Languages, Repo cards uses: chethandvg/profilescape@v1

  • 3D contribution graph

    Turn your GitHub contribution calendar into an animated 3D isometric landscape SVG for your profile README.

    Default cards: 3D contribution landscape uses: chethandvg/profilescape-3d@v1

  • Stats card

    A clean GitHub stats card for your profile README: contributions, commits, pull requests, streaks and more.

    Default cards: Stats uses: chethandvg/profilescape-stats@v1

  • Top languages

    Top languages card for your GitHub profile README, weighted by your real commits, not just repository bytes.

    Default cards: Languages uses: chethandvg/profilescape-languages@v1

  • Repo cards

    Beautiful, self-updating repository cards for your GitHub profile README: stars, forks, languages and releases.

    Default cards: Repo cards uses: chethandvg/profilescape-repo-cards@v1

  • Hero banner, stack and socials

    Animated hero banner, tech stack and social badges for your GitHub profile README, refreshed by a GitHub Action.

    Default cards: Hero banner, Tech stack, Social badges uses: chethandvg/profilescape-hero@v1

  • Contribution grid

    Animated GitHub contribution grid SVG for your profile README, themed to match and rendered with your own token.

    Default cards: Contribution grid uses: chethandvg/profilescape-grid@v1