Forge 42 Documentation Template

A modern documentation template built with React Router v7, Tailwind v4, and content-collections for seamless MDX-based documentation.

Welcome

This is a production-ready documentation template designed to generate beautiful, versioned documentation for your packages. Built on top of @forge-42/base-stack, it combines modern tools for a superior developer experience.

Tech Stack

React Router v7 (Framework mode)
Tailwind v4 with custom components
React 19 with automatic optimizations
content-collections for MDX/MD processing
Vite for blazing-fast builds
Vitest for testing

Key Features

📝 MDX/MD Support - Write documentation in Markdown with React components
🎨 Beautiful UI - Pre-built components including Command K, code blocks, and sidebar navigation
📚 Versioning - Generate docs for multiple versions/releases
🔍 SEO Ready - Automatic sitemaps, robots.txt, and llms.txt generation
⚡ Live Reload - Hot module replacement during development
🚀 Auto Deploy - GitHub Actions + Fly.io integration
🔗 GitHub Links - Edit page and report issue links built-in

Quick Start

# 1. Unzip template under /docs folder
# 2. Install dependencies
pnpm install
# 3. Start development server
pnpm run dev
# 4. Build for production
pnpm run build

FIXME Notes

We've left a few FIXME comments in the codebase marking small customization points. Run this command to find them all:

grep -r "FIXME" --include="*.ts" --include="*.tsx" --include="*.css"

These are quick 2-minute changes like updating your package name or branding colors.

What's Next?

Follow the getting started guide to set up your documentation, understand the project structure, and learn how to organize your content effectively.