readmes

kawaii-shuffle help

Every option is a path segment after https://readmes.pages.dev/kawaii-shuffle/, in any order. Use the builder, then paste the result into your README.

URL builder

Pictures (none = all)

The builder runs in your browser; nothing you choose is sent anywhere except the preview image request.

Preview

Preview of the configured badge

All options

A trailing .svg is allowed and case is ignored. An unknown option renders a small error badge that names its position, for example unknown option #2.

What to show

OptionEffect
randomA random picture on every load (default).
dailyOne picture per day, changing at 00:00 UTC. Cacheable until then.
cycleAnimated crossfade slideshow of all pooled pictures, in shuffled order.
miko, doujin, pale, hanten, jinbeiPick pictures by name. One name always shows it; several names form the pool to shuffle.
speed-NSeconds per picture in cycle mode, 2 to 30 (default 4).

Shape and size

OptionEffect
roundedRounded-corner card (default).
rectSquare corners.
circleCircle avatar; forces the square aspect.
polaroidInstant-photo frame with a caption.
wide, banner, square, portraitAspect ratio 16:9 (default), 3:1, 1:1 or 3:4.
size-NWidth in pixels, 64 to 800 (default 400; 200 for square and portrait).
border-NBorder width in pixels, 0 to 16 (default 0).

Look and feel

OptionEffect
autoFollow the viewer's light or dark preference (default).
light, darkForce a theme.
transparentNo background; frame colors still follow the viewer's preference.
accent-RRGGBBBorder and sparkle color as 3 or 6 hex digits without #, e.g. accent-e91e63.
label, nolabelShow or hide the picture name (polaroid shows it by default).
sparklesAdd twinkling sparkles.

Caching on GitHub

GitHub serves README images through its camo proxy. Random badges are sent with no-store so a new picture is usually fetched, but a browser may still repeat one. Use cycle to guarantee every picture is seen. daily and single-picture URLs are cached on purpose.

Your own pictures

This demo never accepts uploads. Copy the template repository, add your pictures and deploy it to your own free Cloudflare Pages project. The README has step-by-step instructions.