Skip to content

Repository files navigation

Neo-Retro

An oxymoronic design system: not modern, yet not old-school. A UI component registry for Svelte, based on shadcn-svelte but extended with common utilities and components, and a skill for AI coding agents.

1. Initialization

Create a components.json file in your project root with the following configuration:

{
	"$schema": "https://shadcn-svelte.com/schema.json",
	"tailwind": {
		"css": "src/routes/layout.css",
		"baseColor": "neutral"
	},
	"aliases": {
		"components": "$lib/components",
		"utils": "$lib/utils",
		"ui": "$lib/components/ui",
		"hooks": "$lib/hooks",
		"lib": "$lib"
	},
	"typescript": true,
	"registry": "https://neo-retro.zurat.dev/r"
}

Once saved, run the initialization command:

bun x shadcn-svelte@1.1.1 init

2. Add Components

Run the add command to choose which components to install. You can press a to select all of them at once.

bun x shadcn-svelte@1.1.1 add

3. Setup Layout & Styles

Import and wrap your application in the ThemeInit component in your main layout file, e.g., src/routes/+layout.svelte.

<script lang="ts">
  import { ThemeInit, ThemePicker } from '$lib/components/ui/style';

  let { children } = $props();
</script>

<ThemeInit>
  <div class="right-4 top-4 fixed z-50">
    <ThemePicker />
  </div>
  {@render children?.()}
</ThemeInit>

Agent Skill

Install the neo-retro skill for AI coding agents.

mkdir -p .agent/skills/neo-retro-common .agent/skills/neo-retro-components && curl -sL https://raw.githubusercontent.com/z00rat/neo-retro/master/skills/neo-retro-common/SKILL.md -o .agent/skills/neo-retro-common/SKILL.md && curl -sL https://raw.githubusercontent.com/z00rat/neo-retro/master/skills/neo-retro-components/SKILL.md -o .agent/skills/neo-retro-components/SKILL.md

Then add this to your project's AGENTS.md:

- **Component Reference**: See `.agent/skills/neo-retro-common/SKILL.md` for shared types/colors and `.agent/skills/neo-retro-components/SKILL.md` for HTML tag replacements and props for all components.

About

An oxymoronic design system: not modern, yet not old-school.

Resources

Stars

1 star

Watchers

0 watching

Forks

Contributors

Languages