Showing of docs. Showing – of result(s). 108 item(s) available.
Topic Overview
-
Getting Started Overview
Entry point for all audiences — what this project is, who it's for, and where to begin.
-
Platform Overview
Build system, file structure, validation pipeline, deployment, and operational tooling for the core theme framework.
-
Content Management Overview
Content collections, content authoring for editors, and the documentation system.
-
Configuration Overview
All configuration surfaces — site identity, menus, navigation, and layouts.
-
Design System Overview
The three-layer design token architecture — primitives, semantic tokens, and Tailwind bridge.
-
Development Overview
Guides and conventions for building with the theme — component authoring, coding standards, interactivity patterns, icon usage, and external block integration.
-
Components Overview
The component system — base document components, primitives, navigation, UI elements, forms, and search.
-
SEO & Analytics Overview
Search engine optimization and analytics configuration for content visibility.
-
Accessibility Overview
WCAG 2.2 AA compliance baseline, testing expectations, and keyboard interaction patterns.
Getting Started
-
Getting Started Overview
Entry point for all audiences — what this project is, who it's for, and where to begin.
-
Governance and Change Control
How decisions are made, documented, and enforced — charter amendment process, requirement lifecycle, decision log conventions, and approval workflows.
-
Onboarding Guide
Getting started from scratch — cloning the repo, initial setup, first site configuration, first content page, and first deploy.
-
Requirements Catalog Overview
How the canonical requirements system works — structure, lifecycle, and how to use the requirements browser.
-
Site Setup Guide
Step-by-step guide for bootstrapping a new downstream site from the core theme.
-
Documentation Guide
How to write, structure, and maintain documentation in the theme-docs system.
-
Theme Overview
What this theme is, what site archetypes it targets, and what is explicitly out of scope for the v1 baseline.
Platform
-
Platform Overview
Build system, file structure, validation pipeline, deployment, and operational tooling for the core theme framework.
-
Build & Request Pipeline
Request middleware (trailing-slash redirect) and build-time rehype plugins (internal link rewriting) — the two pipeline layers that transform requests and content.
-
Architecture
Cross-cutting technical architecture — rendering strategy, JavaScript usage, accessibility standards, and progressive enhancement principles.
-
Deployment Guide
Operational runbook for production deployment and redeployment after core sync.
-
Directory Structure
Annotated project directory tree — what goes where, file ownership zones, and naming conventions.
-
Docs Kit
Guide to the shared documentation system — what it provides, how child sites use the seed collection, and how to customize, extend, or remove it.
-
File Ownership Model
Reference for the three-zone ownership model — how src/ is organized, what core owns vs. site owns, sync behavior, component overrides, and governance rules.
-
Release Operations
Gate checklist for cutting a core theme release and rollback playbook for reverting a bad release.
-
Static Rules Validation
Reference for the lint:static-rules framework — pluggable build-time source analysis with configurable rules, severity levels, and an inline + manifest exception system.
-
Validation Pipeline
Reference for the npm run validate quality gate — command sequence, per-step specification, accessibility gate, performance budgets, and exception process.
-
Validation Troubleshooting
How to diagnose and fix common validation pipeline failures — format, lint, type check, build, and accessibility gate errors.
Content Management
-
Content Management Overview
Content collections, content authoring for editors, and the documentation system.
-
Content Authoring Guide
How to create, edit, preview, and publish content — a practical guide for editors working with pages and articles.
-
Content Collections
Reference for the content collection system — collection types, frontmatter contracts, URL routing, and content authoring conventions.
-
Content Sections and Routes
Implementation reference for C5 section components, route templates, docs-index behavior, and fragment utility integration.
-
Image Resilience
How broken images degrade gracefully via a site-configurable fallback placeholder.
-
MDX Content Authoring
How to use MDX to combine Markdown content with Astro components for rich page layouts.
Configuration
-
Configuration Overview
All configuration surfaces — site identity, menus, navigation, and layouts.
-
Content Management (CMS)
Enable and configure Sveltia CMS for git-based content editing through a browser-based admin interface.
-
Infinite Loading
Load More progressive enhancement for article listings and docs indexes, with site-level configuration toggle.
-
Layouts
Page layout components — BaseLayout, PageGridLayout, BlankLayout, PageGrid, and Container.
-
Menu Configuration
Reference for the menu configuration contract — main navigation and utility navigation structure, customization pattern, and key design decisions.
-
Navigation System
How the primary, utility, and mobile navigation systems work and how to configure them.
-
Site Configuration
Reference for the site configuration contract — structure, customization pattern, and key sections in src/core/config/site.schema.ts.
-
Site Feature Configuration
Feature toggle configuration — theme mode, theme-docs, article listing, analytics and consent, scroll-to-top, lightbox, and environment variables.
-
Site Style Configuration
Typography and font overrides, fluid token configuration, and the core style override system — everything needed to rebrand the visual layer.
-
View Transitions
Configuration and usage guide for Astro native view transitions — SPA-style navigation with cross-fade animations, per-page opt-out, reduced motion behavior, and animation directive extension points.
-
Layout Recipe: Content Aside
PageGridLayout with main content and a complementary aside column — article detail and documentation patterns.
-
Layout Recipe: Listing Archive
PageGridLayout listing and archive page — card grids, pagination, category/tag filtering, and empty states.
-
Layout Recipe: Marketing Landing
PageGridLayout full-width marketing landing page — hero, feature sections, testimonials, and call-to-action bands.
-
Layout Recipe: Sidebar Content
PageGridLayout with a persistent sidebar for navigation — documentation and multi-page guide patterns.
-
Layout Recipe: Standard Page
PageGridLayout single-column standard page — hero subheader, main content area, and footer sections.
-
Layout Recipe: Three Column
PageGridLayout three-column layout — sidebar navigation, main content, and complementary aside for table of contents or related links.
-
Showcase: Layout Templates
Side-by-side comparison of all PageGridLayout template variants — standard, sidebar, aside, three-column, and full-width patterns.
-
Showcase: PageGridLayout
PageGridLayout grid areas and slot system — subheader, main-header, main, sidebar, aside, and main-footer slot placement.
Design System
-
Design System Overview
The three-layer design token architecture — primitives, semantic tokens, and Tailwind bridge.
-
Design Tokens
Reference for the three-layer design token architecture — naming conventions, layer model, file organization, override mechanism, and lint rules.
-
Override Precedence
Reference for the CSS token override contract — which tokens go in which site files, validation checks, error and warning behavior, and how to declare intentionally new site tokens.
-
Theming How-To
How to customize design tokens for a client site — creating theme overrides, token naming conventions, and testing changes.
-
Showcase: Design Tokens
Primitive, semantic, and on-surface design tokens — color palettes, typography scales, spacing, and fluid token output.
-
Showcase: HTML Elements
Base HTML element styling — headings, paragraphs, lists, tables, blockquotes, code blocks, and inline elements after Tailwind Preflight.
Development
-
Development Overview
Guides and conventions for building with the theme — component authoring, coding standards, interactivity patterns, icon usage, and external block integration.
-
Development Guidelines
Coding conventions, best practices, and anti-patterns — file naming, ownership markers, hydration policy, token usage, vanilla JS patterns, performance, and common mistakes to avoid.
-
Component Authoring
How to create and style components — file conventions, prop patterns, hybrid Tailwind styling, accessibility requirements, and vanilla JS integration.
-
Creating a New Section Type
Step-by-step guide for adding a pure-content section component to the theme.
-
Vanilla JS Interactivity Patterns
Conventions for self-contained vanilla JavaScript interactive components — data-slot, data-state, WeakMap, TypeScript classes, lifecycle hooks, and AbortController cleanup.
-
Icon Usage
How to use icons — the Icon component, SVG resolution, shadowing, and accessibility.
-
Design Block Integration
How the project integrates external design block sources — Tailwind Plus, Flowbite, Starwind, and custom composition.
-
Animation Layer
Motion Mini animation utilities for scroll-reveal effects, presets, stagger, and reduced-motion handling.
-
Using Design Blocks in Child Sites
How child sites consume Starwind components via the token bridge and adapt design reference blocks from Tailwind Plus and Flowbite.
-
Showcase: Animation
Scroll-reveal presets, stagger, raw keyframes, and reduced-motion behavior using Motion Mini.
Components
-
Components Overview
The component system — base document components, primitives, navigation, UI elements, forms, and search.
-
ArticleCard
Card component for article listing and paginated archive pages.
-
Base Components
Document-level SEO and shell utilities — SEO, Analytics, Favicon, SkipLink, ConsentBanner, and ConsentReset.
-
CallToAction
Standalone call-to-action block with stacked and split layout variants, optional media, and built-in analytics tracking.
-
Drawer
Slide-in overlay primitive with focus trapping, scroll lock, ESC close, and reduced-motion support.
-
FeatureGrid
Card grid section with optional icons, powered by SectionCard, for showcasing features or capabilities.
-
Footer Navigation
Reference for Footer, UtilityNav, and SocialLinks components, including C4 layout composition and configuration-driven behavior.
-
Forms & Submission
Form primitives, contact form, newsletter signup, server-side submission pipeline, CAPTCHA, and spam protection.
-
Header & Navigation
Site header shell, desktop and mobile navigation, theme switcher, search trigger, site logo, and the Drawer overlay primitive.
-
Hero
Full-width hero section with dual-mode rendering — compact page-title band or full hero with image and actions.
-
InfoCards
Card grid section powered by SectionCard for displaying structured content items with media, badges, and action links.
-
Image Lightbox
Full-screen image lightbox overlay with gallery navigation, keyboard/touch support, and progressive enhancement — covers Lightbox (overlay) and LightboxImage (trigger) components.
-
Interactive Components
Reference for Accordion, Tabs, Tooltip, CopyButton, PostShare, Sticky TOC, Scroll-to-Top, YouTubeEmbed, and Embed.
-
SurfaceBox
Lightweight styled box primitive with background variants and overflow clipping for constrained surfaces.
-
Primitive Components
Low-level UI building blocks — icons, buttons, links, headings, badges, dates, sections, dropdowns, and list boxes.
-
Search
Pagefind search integration, global search modal, dedicated search page, and search event stubs.
-
SectionCard
Shared card primitive used by InfoCards and FeatureGrid section components.
-
Table of Contents
Three-component TOC architecture — shared link list, sticky sidebar with active-link tracking, and collapsible inline display.
-
Testimonials
Quote card section with grid and centered layout variants, supporting avatars, attribution links, and card background surfaces.
-
UI Components
Breadcrumbs, EmptyState, Pagination, PrevNextNav, and RelatedContent component reference.
-
Separator
Styled horizontal rule or vertical divider with visual variants for content separation.
-
ButtonGroup
Flex wrapper for grouping multiple Button components with configurable direction, alignment, and gap.
-
Pullquote
Decorative pull quote with citation, visually distinct from standard prose blockquotes.
-
TimeToRead
Presentational reading time display with icon, consuming the remark-reading-time plugin output.
-
Columns
Generic N-column CSS grid layout with responsive collapse and three column patterns.
-
MediaText
Content-level split layout with image and text, reversible order and configurable split ratios.
-
Table
Responsive styled table wrapper with horizontal scroll and stacked mobile layout options.
-
Gallery
Image grid layout composing LightboxImage with configurable columns and lightbox group integration.
-
Cover
Background image with overlay and positioned content for hero-style blocks and feature highlights.
-
MasonryGallery
CSS columns-based masonry layout for images with lightbox integration.
-
Timeline
Vertical timeline for project histories, about pages, and changelogs with date markers.
-
Showcase: Cards & Testimonials
InfoCards, FeatureGrid, and Testimonials — card orientations, full-card click behavior, item-level overrides, and grid/centered layouts.
-
Showcase: Content Composition & Fragment
Visual QA showcase for LayoutSection composition patterns and fragment rendering.
-
Showcase: Form Primitives
Form field primitives, validation states, ContactForm section, and NewsletterSignup section.
-
Showcase: Header & Navigation
Site header, main navigation, mobile menu, utility bar, and breadcrumb rendering across breakpoints.
-
Showcase: Hero & CallToAction
Hero and CallToAction section variants — heading sizes, action buttons, stacked and inline layouts, and background surfaces.
-
Showcase: Image Lightbox
Visual QA showcase for the Image Lightbox component — gallery navigation, captions, hi-res sources, and progressive enhancement.
-
Showcase: Interactive Components
Interactive primitives — accordion, dropdown, drawer, scroll-to-top, copy button, and theme toggle.
-
Showcase: Primitive Components
Heading, Button, Icon, Link, Badge, LayoutSection, and SurfaceBox primitives — variants, sizes, and token usage.
-
Showcase: Search
Pagefind-powered search modal — keyboard navigation, result rendering, and empty-state handling.
-
Showcase: UI Components
Breadcrumbs, pagination, table of contents, empty state, prev/next navigation, and article card components.
-
Showcase: Gallery Components
Visual demo of Gallery and MasonryGallery components with lightbox integration.
SEO & Analytics
-
SEO & Analytics Overview
Search engine optimization and analytics configuration for content visibility.
-
Analytics & Consent
Consent banner configuration, consent states, script injection lifecycle, trackEvent() usage, custom snippets, and consent revocation.
-
Redirects
How to configure URL redirects using the global manifest and content-level frontmatter, including conflict handling and query parameter behavior.
-
SEO and Analytics
SEO metadata requirements, the SEO component contract, and analytics/privacy compliance guidance including CCPA.
-
Showcase: Consent & Analytics
Cookie consent banner, analytics integration, and consent-state persistence across sessions.
Accessibility
-
Accessibility Overview
WCAG 2.2 AA compliance baseline, testing expectations, and keyboard interaction patterns.
-
Accessibility Standards
WCAG 2.2 AA compliance policy — baseline requirements, ARIA rules, color contrast, testing expectations, and exception process.
-
Keyboard Testing Checklist
Per-component keyboard interaction testing checklist — tab order, focus management, ARIA state announcements, and escape behavior.
No docs match the current filters.