Skip to content

Pandemonium-Research/Skilldex-web

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

30 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Skilldex Web

The official marketing and documentation website for Skilldex β€” the package manager for Claude Code skills.

🎯 Overview

Skilldex Web is a Next.js-based website that serves as the central hub for the Skilldex ecosystem. It provides:

  • Landing page showcasing the Skilldex platform and its core benefits
  • Comprehensive documentation including CLI reference, concepts, and publishing guides
  • Installation instructions for the Skilldex CLI across multiple platforms
  • Registry preview and skill discovery interface
  • Educational content about skill creation, validation, and best practices

This repository hosts the website infrastructure while the CLI tool and registry backend are maintained separately.

πŸš€ What is Skilldex?

Skilldex solves a fundamental problem in the Claude Code ecosystem: how to package, share, and discover reusable AI agent instruction sets (skills).

Think of it like npm, but for AI agent capabilities instead of JavaScript libraries:

  • Skills are markdown files containing reusable instruction sets that extend what Claude Code can do
  • The CLI (skillpm) provides commands to install, manage, and publish skills
  • The Registry is a central hub for discovering and publishing vetted skills
  • The Spec defines what makes a valid, conformant skill

The Problem Skilldex Solves

  1. No central home β€” Skills live scattered across projects with no standard way to share them
  2. No install command β€” Sharing a skill means attaching files to messages, no versioning or distribution
  3. No quality signal β€” No way to know if a skill follows standards, targets current Claude versions, or is maintained

πŸ“ Project Structure

skilldex-web/
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ app/                          # Next.js application routes
β”‚   β”‚   β”œβ”€β”€ layout.tsx               # Root layout with navbar and footer
β”‚   β”‚   β”œβ”€β”€ page.tsx                 # Landing page
β”‚   β”‚   β”œβ”€β”€ globals.css              # Global styles (Tailwind)
β”‚   β”‚   β”œβ”€β”€ docs/                    # Documentation pages
β”‚   β”‚   β”‚   β”œβ”€β”€ layout.tsx           # Docs layout with sidebar
β”‚   β”‚   β”‚   β”œβ”€β”€ page.tsx             # Docs index
β”‚   β”‚   β”‚   └── [...slug]/page.tsx   # Dynamic doc pages
β”‚   β”‚   └── install/                 # CLI installation page
β”‚   β”‚       └── page.tsx
β”‚   β”œβ”€β”€ components/
β”‚   β”‚   β”œβ”€β”€ landing/                 # Landing page sections
β”‚   β”‚   β”‚   β”œβ”€β”€ Hero.tsx             # Main hero section
β”‚   β”‚   β”‚   β”œβ”€β”€ ProblemSection.tsx   # Problem statement
β”‚   β”‚   β”‚   β”œβ”€β”€ HowItWorks.tsx       # 3-step workflow visualization
β”‚   β”‚   β”‚   β”œβ”€β”€ TerminalDemo.tsx     # Animated terminal demo
β”‚   β”‚   β”‚   β”œβ”€β”€ RegistryPreview.tsx  # Registry preview
β”‚   β”‚   β”‚   └── InstallStrip.tsx     # Install CTA strip
β”‚   β”‚   β”œβ”€β”€ docs/                    # Documentation components
β”‚   β”‚   β”‚   β”œβ”€β”€ DocsSidebar.tsx      # Navigation sidebar
β”‚   β”‚   β”‚   β”œβ”€β”€ DocsSidebarClient.tsx # Client-side sidebar logic
β”‚   β”‚   β”‚   β”œβ”€β”€ DocsPager.tsx        # Previous/next page navigation
β”‚   β”‚   β”‚   └── MdxContent.tsx       # MDX content renderer
β”‚   β”‚   β”œβ”€β”€ install/
β”‚   β”‚   β”‚   └── InstallTabs.tsx      # Platform selection tabs
β”‚   β”‚   β”œβ”€β”€ layout/
β”‚   β”‚   β”‚   β”œβ”€β”€ Navbar.tsx           # Site navigation
β”‚   β”‚   β”‚   └── Footer.tsx           # Site footer
β”‚   β”‚   └── ui/                      # Reusable UI components
β”‚   β”‚       β”œβ”€β”€ Badge.tsx            # Badge component
β”‚   β”‚       β”œβ”€β”€ CodeBlock.tsx        # Syntax-highlighted code
β”‚   β”‚       β”œβ”€β”€ CopyButton.tsx       # Copy-to-clipboard button
β”‚   β”‚       └── TabSwitcher.tsx      # Tab switcher component
β”‚   β”œβ”€β”€ content/
β”‚   β”‚   └── docs/                    # MDX documentation files
β”‚   β”‚       β”œβ”€β”€ cli/                 # CLI command references
β”‚   β”‚       β”‚   β”œβ”€β”€ install.mdx
β”‚   β”‚       β”‚   β”œβ”€β”€ list.mdx
β”‚   β”‚       β”‚   β”œβ”€β”€ publish.mdx
β”‚   β”‚       β”‚   β”œβ”€β”€ suggest.mdx
β”‚   β”‚       β”‚   β”œβ”€β”€ uninstall.mdx
β”‚   β”‚       β”‚   └── validate.mdx
β”‚   β”‚       β”œβ”€β”€ concepts/            # Core concepts
β”‚   β”‚       β”‚   β”œβ”€β”€ manifest.mdx
β”‚   β”‚       β”‚   β”œβ”€β”€ quality-scoring.mdx
β”‚   β”‚       β”‚   β”œβ”€β”€ scopes.mdx
β”‚   β”‚       β”‚   └── skill-format.mdx
β”‚   β”‚       β”œβ”€β”€ getting-started/     # Onboarding guides
β”‚   β”‚       β”‚   β”œβ”€β”€ index.mdx
β”‚   β”‚       β”‚   β”œβ”€β”€ installation.mdx
β”‚   β”‚       β”‚   β”œβ”€β”€ quick-reference.mdx
β”‚   β”‚       β”‚   └── first-skill.mdx
β”‚   β”‚       └── publishing/          # Publishing guides
β”‚   β”‚           β”œβ”€β”€ creating-a-skill.mdx
β”‚   β”‚           β”œβ”€β”€ packaging.mdx
β”‚   β”‚           └── publishing-to-registry.mdx
β”‚   β”œβ”€β”€ lib/
β”‚   β”‚   └── docs.ts                  # Documentation utilities
β”‚   β”‚       └── Functions for parsing, organizing, and navigating MDX files
β”‚   └── types/
β”‚       β”œβ”€β”€ docs.ts                  # Type definitions for documentation
β”‚       └── registry.ts              # Type definitions for registry data
β”œβ”€β”€ public/                          # Static assets
β”œβ”€β”€ package.json
β”œβ”€β”€ tsconfig.json
β”œβ”€β”€ tailwind.config.ts              # Tailwind CSS configuration
β”œβ”€β”€ postcss.config.js               # PostCSS configuration
β”œβ”€β”€ next.config.mjs                 # Next.js configuration
└── README.md

πŸ—οΈ Architecture & Technology Stack

Core Technologies

  • Next.js 14.2 β€” React framework with app router, SSR, and static generation
  • React 18 β€” UI library
  • TypeScript β€” Static type checking for robust code quality
  • Tailwind CSS 3 β€” Utility-first styling framework
  • MDX β€” Markdown with JSX for rich documentation content

Key Libraries

  • next-mdx-remote β€” Renders MDX content dynamically
  • gray-matter β€” Parses YAML frontmatter from MDX files
  • shiki β€” Syntax highlighting for code blocks with theme support
  • clsx β€” Utility for conditional classNames
  • tailwind-merge β€” Merges Tailwind class names intelligently

Design Decisions

  1. MDX for Documentation β€” Allows embedding React components within markdown, enabling interactive docs
  2. Static Site Generation β€” Most pages are pre-rendered at build time for optimal performance
  3. File-based Routing β€” Documentation structure mirrors filesystem structure for maintainability
  4. Tailwind CSS β€” Rapid development with consistent design tokens

🎨 Key Features

1. Landing Page

  • Hero Section β€” Introduces Skilldex and the CLI
  • Problem Statement β€” Illustrates what Skilldex solves
  • How It Works β€” 3-step workflow with code examples
  • Terminal Demo β€” Animated demonstration of CLI usage
  • Registry Preview β€” Showcases available skills
  • Call-to-Action β€” Guides users to get started

2. Documentation Site

  • Sidebar Navigation β€” Auto-generated from document frontmatter
  • Multi-section organization:
    • Getting Started β€” Onboarding and basic setup
    • Concepts β€” Core ideas (skill format, quality scoring, scopes)
    • CLI Reference β€” Complete command documentation
    • Publishing β€” Guides for creating and publishing skills
  • Page Navigation β€” Previous/next page links
  • Rich Content β€” Syntax-highlighted code blocks, badges, callouts

3. Installation Page

  • Platform Tabs β€” macOS, Linux, Windows installation methods
  • Multiple Package Managers β€” npm (all platforms), Homebrew (via brew tap pandemonium-research/skilldex, macOS/Linux), Scoop (via scoop bucket add skilldex, Windows)
  • Clear Instructions β€” Step-by-step setup guides

4. UI Components

  • CodeBlock β€” Syntax-highlighted code with copy button (using Shiki)
  • CopyButton β€” One-click copy-to-clipboard for code
  • TabSwitcher β€” Content tabs for comparing options
  • Badge β€” Labels for skill tiers (Verified, Community)
  • Responsive Design β€” Mobile-first, works across all devices

πŸ“– Documentation Structure

All documentation is stored as MDX files in src/content/docs/ with YAML frontmatter:

---
title: "Page Title"
description: "Brief description for metadata"
section: "Section Name" # e.g., "Getting Started", "Concepts", "CLI Reference"
order: 1 # Sort order within section
editUrl?: "github.com/..." # Optional link to edit on GitHub
---
# Content goes here...

The documentation system automatically:

  • Parses frontmatter and file structure
  • Generates navigation trees by section
  • Creates page slugs from file paths (/docs/section/page)
  • Indexes all documents for navigation

πŸš€ Getting Started

Prerequisites

  • Node.js 18+
  • npm or yarn

Installation

# Clone the repository
git clone https://github.com/Pandemonium-Research/Skilldex-web.git
cd Skilldex-web

# Install dependencies
npm install

# Start development server
npm run dev

The site will be available at http://localhost:3000

Building for Production

# Build the static site
npm run build

# Start production server
npm start

Linting

npm run lint

πŸ”§ Development

Adding Documentation

  1. Create a new .mdx file in src/content/docs/ (in the appropriate section folder)
  2. Add required frontmatter (title, description, section, order)
  3. Write markdown content with optional JSX components
  4. The site will automatically detect and route the new page

Example:

---
title: "My New Guide"
description: "A guide about something useful"
section: "Getting Started"
order: 5
---

# My New Guide

Here's some content with a [code block](my-file.ts).

Adding Components

  1. Create new component in src/components/ in the appropriate subdirectory
  2. Use TypeScript for type safety
  3. Style with Tailwind CSS classes
  4. Export from component file for use in pages/layouts

Styling

The project uses Tailwind CSS with custom design tokens defined in tailwind.config.ts:

  • Color palette (brand, surface, text, terminal colors)
  • Typography scales
  • Spacing system
  • Responsive breakpoints

πŸ“‹ Key Concepts

Skills

Reusable instruction sets for Claude Code. Each skill is a SKILL.md file with YAML frontmatter containing metadata and the instruction content.

Quality Scoring

A 0-100 format conformance score measuring how well a skill follows the Skilldex spec. Calculated by checking:

  • Presence of required frontmatter fields
  • Valid semantic versioning
  • Resource file integrity
  • Markdown validity
  • Documentation quality

Skill Scopes

Three installation contexts:

  • Global β€” Available in all Claude Code sessions
  • Shared β€” Shared with team members
  • Project β€” Checked into repository

Spec Version

Skills declare which Skilldex specification version they conform to, ensuring forward compatibility.

πŸ”— Related Repositories

  • CLI Tool β€” The skillpm command-line interface (npm install -g skilldex-cli)
  • Homebrew Tap β€” brew tap pandemonium-research/skilldex && brew install skilldex-cli (macOS/Linux)
  • Scoop Bucket β€” scoop bucket add skilldex https://github.com/Pandemonium-Research/scoop-skilldex && scoop install skilldex-cli (Windows)
  • npm Package β€” Published package on npm (all platforms)
  • Registry Backend β€” The skill registry API and storage (coming soon)

🀝 Contributing

Contributions welcome! Areas for improvement:

  • Documentation β€” More guides, examples, and tutorials
  • Components β€” New UI components for docs or landing
  • Features β€” Interactive registry, search functionality
  • Localization β€” Support for multiple languages
  • SEO β€” Improved metadata and structured data

πŸ“„ License

MIT License β€” Skilldex is open source and free to use.


Learn more: Visit skilldex-web.vercel.app or read the full documentation for detailed guides and API reference.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors