CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

AuthentiKate is a documentation site for an OIDC/SSO solution for homelabbers. The project uses VitePress (Vue.js based static site generator) to build and serve documentation.

Development Commands

Core Development

npm run docs:dev - Start VitePress development server with hot reloading
npm run docs:build - Build static site for production
npm run docs:preview - Preview production build locally

Package Management

Uses npm for package management (package.json, package-lock.json present)
Also has bun.lock indicating Bun package manager usage

Architecture & Structure

VitePress Configuration

Main config: .vitepress/config.mjs
Uses VitePress default theme with local search enabled
Navigation configured for Home, Quick Start, and Documentation sections
Clean URLs enabled

Content Structure

index.md - Homepage with hero layout and feature sections
installation.md - Installation guide (currently minimal)
api-examples.md - Runtime API examples for VitePress
docs/ - Main documentation directory containing:
- getting-started.md - Getting started guide (contains legacy Jigsaw content)
- algolia-docsearch.md, custom-404-page.md, customizing-your-site.md, navigation.md
user-guide/ - User guide section (files appear empty)

Styling & Assets

Uses TailwindCSS v4+ with PostCSS
PostCSS config: postcss.config.mjs
Public assets in public/ directory
Banner image: public/banner.png

Legacy Migration Status

The codebase appears to be in transition from Jigsaw (PHP static site generator) to VitePress:

Git status shows many deleted Jigsaw files (.blade.php, composer.json, PHP configs)
docs/getting-started.md still contains Jigsaw-specific content and PHP examples
VitePress structure is in place but content needs updating

Key Technical Details

Dependencies

Vue 3.5.18 (runtime)
VitePress 1.6.3 (static site generator)
TailwindCSS 4.1.11 with Vite integration
PostCSS for CSS processing

Site Configuration

Site title: "AuthentiKate"
Description: "The OIDC/SSO solution for homelabbers"
GitHub link placeholder (currently points to VitePress repo)
Local search enabled
Sidebar configuration commented out (needs setup)

Development Workflow

Use npm run docs:dev for development with live reload
Content is written in Markdown with frontmatter
VitePress processes Vue components and runtime APIs
TailwindCSS handles styling through PostCSS
Build with npm run docs:build for production deployment

Content Migration Tasks

The site needs content migration from legacy Jigsaw structure:

Update docs/getting-started.md to remove PHP/Jigsaw references
Populate empty user guide files
Configure proper navigation sidebar
Update GitHub social link to correct repository
Complete feature descriptions on homepage

3.0 KiB Raw Blame History