Skip to content

dirsigler/astro-techradar

Repository files navigation

@dirsigler/astro-techradar

npm version Built with Astro License: MIT

An Astro integration that adds a complete, interactive technology radar to your site. Track technology adoption decisions across your organization with a visual radar chart, categorized segments, and detailed technology pages — all driven by simple Markdown files.

View Live Demo


Preview

Radar Overview Technology Detail
Radar Light Technology Page
Radar Dark Segment Page

Features

  • Interactive SVG Radar — Technologies plotted across four rings (Adopt, Trial, Assess, Hold) with hover tooltips and click-through navigation
  • Markdown-Driven — Add technologies by dropping .md files into segments/. No code changes needed
  • Theming & Color Mode — Ships with a default theme and Catppuccin Mocha. Light/dark toggle, lockable color mode, or create your own theme with CSS custom properties
  • Fully Static & Fast — Builds to plain HTML/CSS/JS. Deploy anywhere
  • Movement Indicators — Mark technologies as moved in/out to highlight recent changes
  • SEO Ready — Open Graph, Twitter Cards, canonical URLs, and custom 404 page
  • RSS Feed — Auto-generated feed at {basePath}/feed.xml for subscribers
  • Owner Attribution — Assign teams or individuals to technologies
  • External Links — Link technologies to docs, repos, communities with typed icons
  • Tags & Filtering — Cross-cutting tags for discovery, filterable on the main radar page
  • Related Technologies — Manual and auto-suggested related technologies on detail pages
  • Keyboard Navigation — Arrow keys to cycle radar dots, focus indicators, screen reader friendly

Quick Start

1. Install

npm install @dirsigler/astro-techradar astro

2. Add the integration

// astro.config.mjs
import { defineConfig } from "astro/config";
import techradar from "@dirsigler/astro-techradar";

export default defineConfig({
  site: "https://your-site.example.com",
  integrations: [
    techradar({
      title: "Tech Radar",
    }),
  ],
});

3. Define the content collections

Create src/content.config.ts:

import { defineCollection } from "astro:content";
import { glob } from "astro/loaders";
import { segmentSchema, technologySchema } from "@dirsigler/astro-techradar/schemas";

const segments = defineCollection({
  loader: glob({ pattern: "*/index.md", base: "./segments" }),
  schema: segmentSchema,
});

const technologies = defineCollection({
  loader: glob({ pattern: "*/!(index).md", base: "./segments" }),
  schema: technologySchema,
});

export const collections = { segments, technologies };

4. Add your content

segments/
├── cloud/
│   ├── index.md          # Segment metadata
│   ├── kubernetes.md
│   └── terraform.md
├── frameworks/
│   ├── index.md
│   ├── astro.md
│   └── react.md
└── ...

Each segment needs an index.md:

---
title: Cloud
color: "#3b82f6"
order: 1
---

Each technology file:

---
title: Kubernetes
ring: adopt
moved: 0
owner:
  name: Platform Engineering
  url: https://github.com/orgs/example/teams/platform
tags:
  - cloud-native
  - containers
related:
  - cloud/helm
  - cloud/argocd
links:
  - label: Documentation
    url: https://kubernetes.io/docs/
    type: docs
  - label: GitHub
    url: https://github.com/kubernetes/kubernetes
    type: repo
  - label: Kubernetes Slack
    url: https://kubernetes.slack.com
    type: community
history:
  - date: "2025-03"
    ring: adopt
    description: "Promoted after 2 years of successful production use."
  - date: "2023-01"
    ring: trial
    description: "Started evaluating for container orchestration."
  - date: "2022-06"
    ring: assess
---

Your description in Markdown. Explain why this technology is in this ring
and what your experience has been.

owner (optional)

Displays a team or person responsible for this technology on the detail page.

Field Required Description
name yes Owner name (e.g. team, guild, or person)
url no Link to an external resource (GitHub team, Slack channel, wiki page)

links (optional)

External resource links displayed inline on the detail page. Links are automatically sorted by type in a consistent order: docs, repo, website, community.

Field Required Description
label yes Display text for the link
url yes Full URL
type no Link type — determines the icon. One of docs, repo, website, community. Defaults to website

tags (optional)

Free-text tags for cross-cutting concerns (e.g. cloud-native, security, iac). Tags appear as #tag pills on the detail page and enable tag-based filtering on the main radar page. Clicking a tag pill navigates to the radar filtered by that tag.

related (optional)

A list of technology slugs (matching entry IDs like cloud/helm) to display as related technologies on the detail page. In addition to these manual entries, the radar automatically suggests technologies that share 2 or more tags with the current entry.

history (optional)

When present, a timeline is rendered on the technology detail page showing how its ring classification changed over time.

Field Required Description
date yes Free-text date string (e.g. "2025-03", "Q1 2025")
ring yes The ring at that point in time (adopt, trial, assess, hold)
description no Short rationale for the change

5. Run

npx astro dev

Configuration

All options are passed to the techradar() integration in astro.config.mjs:

techradar({
  // Required
  title: "Tech Radar",

  // Optional
  basePath: "/techradar", // Mount under a sub-path (e.g. acme.com/techradar/)
  logo: "/logo.svg", // Path to logo in public/
  footer: "Built by the Platform Team", // Supports HTML
  editing: {
    enabled: true, // Show "Edit this page" links (default: true)
    baseUrl: "https://github.com/your-org/your-radar/edit/main/segments",
  },
  theme: "default", // 'default' | 'catppuccin-mocha' | path to custom CSS
  color: {
    toggle: true, // Show the light/dark mode toggle (default: true)
    mode: "system", // 'light' | 'dark' | 'system' (default: 'system')
  },
  search: {
    enabled: true, // Show the search input in the navbar (default: true)
    placeholder: "Search technologies...", // Placeholder text
  },
  feed: true, // Enable RSS feed at {basePath}/feed.xml (default: true)
  socialLinks: [
    {
      label: "GitHub",
      href: "https://github.com/your-org/your-radar",
      icon: "github", // Lucide icon name (requires @iconify-json/lucide)
    },
  ],
});

Social Link Icons

Social links can optionally display Lucide icons. If you use the icon field, install the icon set:

npm install @iconify-json/lucide
socialLinks: [
  { label: "GitHub", href: "https://github.com/your-org", icon: "github" },
],

Technology Frontmatter

Field Type Description
title string Display name
ring 'adopt' | 'trial' | 'assess' | 'hold' Which ring the technology belongs to
moved -1 | 0 | 1 Movement indicator (-1 = out, 0 = none, 1 = in)
owner { name, url? } Optional team/person responsible (see owner)
links Array<{ label, url, type? }> Optional external links (see links)
tags string[] Optional free-text tags for filtering (see tags)
related string[] Optional technology slugs for related (see related)
history Array<{ date, ring, description? }> Optional ring change timeline (see history)

Segment Frontmatter

Field Type Description
title string Segment display name
color string Hex color (e.g. "#3b82f6")
order number Quadrant position (1-4)

Theming

Themes are CSS files defining --radar-* custom properties.

Theme Description
default Clean light/dark theme (follows system preference)
catppuccin-mocha Catppuccin Mocha dark theme

To create a custom theme, copy the default theme, save it in your project, and point to it:

techradar({
  theme: "./src/my-theme.css",
});

Color Mode

Control the light/dark mode behavior with the color option:

// Default — toggle visible, follows system preference
techradar({ title: "Tech Radar" });

// Lock to dark mode, no toggle
techradar({
  title: "Tech Radar",
  color: { toggle: false, mode: "dark" },
});

// Lock to light mode, no toggle
techradar({
  title: "Tech Radar",
  color: { toggle: false, mode: "light" },
});
Field Type Default Description
toggle boolean true Show the light/dark mode toggle in the header
mode 'light' | 'dark' | 'system' 'system' Color mode — locks the mode when toggle is false

Base Path

Mount the radar under a sub-path when embedding it into a larger Astro site:

// Serves the radar at acme.com/techradar/
techradar({
  title: "ACME Tech Radar",
  basePath: "/techradar",
});

All routes and internal links are automatically prefixed. This works alongside Astro's own base config for full flexibility.


Example

See the techradar-demo repository for a complete working example.


License

MIT — Dennis Irsigler

About

An interactive, fully static technology radar built with Astro. Track technology adoption decisions with a visual radar chart — driven entirely by Markdown files.

Topics

Resources

License

Stars

5 stars

Watchers

0 watching

Forks

Sponsor this project

 

Contributors