Skip to content
VibeFather
Sign up free

2 cases built from this template

Same prompt, different [VARIABLES]. Click one to preview it above.

About this template

Product Documentation Website is a guides-first technical documentation template built for developer SDKs, APIs, and software platforms. It implements the classic three-column reading experience: a collapsible left navigation rail with active section tracking, a focused central documentation column, and a right-hand 'On this page' table of contents that highlights the active heading as you scroll. Content lives in 18+ local Markdown files organized into logical guide groups, making it effortless for teams to add or edit pages without touching React components. Key developer ergonomics work out of the box: a v2 / v3 version switcher that genuinely swaps prose, endpoints, and parameter tables; synchronized JavaScript, Python, and cURL code tabs across the entire page with one-click copy buttons; styled callouts (note, tip, warning, danger); numbered step lists; structured parameter tables; and an interactive 'Try it' request runner that returns realistic mocked JSON payloads. A Cmd+K search palette indexes every document heading with full keyboard navigation, while prev/next links, an edit-this-page link, local 'Was this page helpful?' feedback, a versioned changelog, and a helpful 404 route complete the shell. Styled in crisp paper white, graphite (#1C1E26), ultraviolet (#6C4CFF), and lime code highlights (#C3F53C) with a dark mode toggle, the site adapts smoothly to mobile drawers and swap-ready variables for any SDK brand.

The template prompt

The live demo was built from exactly this text — nothing added. The other cases only change the values of the [VARIABLES].

# Product Documentation Website

Build this website exactly as described below. Replace the [VARIABLES] with your own values; keep everything else.

## Brief
Build a guides-first, three-column developer SDK documentation website for [BRAND] (`[PKG_NAME]`), backed by 18+ local Markdown files bundled directly into the static build. Includes a working v2/v3 version switcher, page-wide synchronized JavaScript/Python/cURL code tabs, an interactive 'Try it' request playground, Cmd+K heading search, scroll-tracked right table of contents, local helpfulness feedback, changelog, and a custom 404 page.

- Audience: Software engineers, developer-experience leads, and technical writers shipping SDK guides and API references.
- Goal: Give visitors an authoritative, fast-scanning documentation site that opens directly on a rich Quickstart guide with live code tabs, steps, callouts, and an interactive request panel right on the first screen.
- Tone: Clear, direct, engineering-first technical writing with concrete payloads, crisp parameter definitions, and zero marketing filler.

## Stack
- Framework: Vite 6 + React 18 + TypeScript
- Styling: Tailwind CSS 4
- Libraries: lucide-react (ISC), @fontsource/plus-jakarta-sans (OFL-1.1), @fontsource/inter (OFL-1.1), @fontsource/jetbrains-mono (OFL-1.1)
- Build: `npm run build` → static files in `dist/`. No backend, no server code, no external APIs.
- Setup:
  - Set base: './' and build: { sourcemap: false } in vite.config.ts.
  - Import @fontsource/plus-jakarta-sans (600, 700, 800), @fontsource/inter (400, 500, 600), and @fontsource/jetbrains-mono (400, 500, 600) in src/main.tsx.
  - Store 18+ real Markdown documentation pages under src/content/docs/*.md and import them statically via import.meta.glob('./content/docs/*.md', { query: '?raw', import: 'default', eager: true }).
  - Parse Markdown front matter, headings, callout blocks (:::note, :::tip, :::warning, :::danger), numbered steps, parameter tables, and synced code-tab groups in src/utils/docParser.ts.
  - Persist preferred code language, active SDK version (v3/v2), color theme (light/dark), and 'Was this page helpful?' votes in src/data/docStorage.ts.

## Variables
- [BRAND] — SDK Brand Name (default: "RelayMesh"). Fictional developer SDK product name
- [PKG_NAME] — Package Slug (default: "relaymesh"). Lowercase npm/pip package and CLI slug
- [API_BASE] — Mock API Base URL (default: "https://api.relaymesh.dev"). Fictional endpoint URL shown in cURL and Try It panels
- [TAGLINE] — SDK One-Line Summary (default: "Low-latency event routing, signed webhooks, and fan-out delivery for modern services."). Short technical subtitle for the intro banner
- [CREDIT] — keep a small "Template by VibeFather" link to https://vibefather.ai/t/product-documentation-website in the footer (default: yes; delete this line to remove it)

The copy under Pages & Sections is written for the default values. If your values differ, rewrite every headline, paragraph, label and image for them — same length, tone and structure. Layout, colors, type and motion stay as described.
Keep all copy, image paths and links in one content file (for example `src/content.ts`), keyed by section, so the content can be swapped later without touching components.

## Design
### Colors
- Paper White `#FFFFFF` — Primary light-mode reading canvas and header surface
- Soft Rail `#F6F7FB` — Sidebar surface, table headers, and callout fills in light mode
- Graphite Ink `#1C1E26` — Primary text in light mode and dark code-block / dark-mode base surface
- Deep Obsidian `#12141B` — Dark-mode page background with #1C1E26 cards and #F2F4F8 foreground text
- Ultraviolet Accent `#6C4CFF` — Active sidebar item, TOC scroll indicator, primary buttons, and interactive links (lightened to #9B85FF in dark mode for AA contrast)
- Lime Highlight `#C3F53C` — Code syntax highlights, HTTP 200 status badge inside dark graphite code frames, and active code-tab underline
- Amber Caution `#F59E0B` — Warning callouts and v2 deprecation notice pills
- Crimson Alert `#E5484D` — Danger callouts and error status codes

### Typography
- Headings & Display: Plus Jakarta Sans (OFL), weights 600/700/800
- Body Prose & UI: Inter (OFL), weights 400/500/600
- Code, Endpoints & Tables: JetBrains Mono (OFL), weights 400/500/600

### Layout & motion
- Spacing: Crisp editorial reading grid: 60px sticky top bar, 260px left sidebar, 760px optimal-measure central reading column, 220px right 'On this page' TOC on desktop (1440px); 24px–32px section gaps.
- Radius: 6px for badges, buttons, and search inputs; 10px for dark graphite code frames, callouts, and interactive Try It panels.
- Motion: Smooth 150ms active-indicator glide on sidebar links, synced code tabs, and right-hand TOC highlight.
- Motion: Crisp 160ms expand/collapse on sidebar groups and Cmd+K search modal fade.
- Motion: Respect prefers-reduced-motion across all transitions and smooth-scroll jumps.
- Imagery: Pure code-drawn technical graphics: geometric ultraviolet/lime SVG logo mark for [BRAND], inline SVG request-pipeline architecture diagram on the Quickstart page, crisp Lucide icons for callouts and controls, and high-contrast dark graphite code frames with lime highlights. No external photos.

## Pages & Sections
### Quickstart · [BRAND] Docs (`#/docs/quickstart`)
1. **Top Documentation Bar & Three-Column Shell** — Sticky 60px top header with custom geometric SVG mark + [BRAND] Docs wordmark, top-level links (Guides, API Reference, Changelog, 404 Demo), live Version Switcher dropdown ('v3 (Latest)' / 'v2 (Legacy)' — switching genuinely updates page prose, code examples, endpoint paths `/v3/events` vs `/v2/dispatch`, and shows an Amber v2 notice banner), Cmd+K search trigger button, and Light/Dark theme toggle. Left 260px sidebar lists 5 collapsible groups covering 18+ seeded Markdown pages: Getting Started (Quickstart, Installation, Authentication, Configuration), Core Concepts (Event Routing, Signed Webhooks, Retry Policies, Dead-Letter Queues, Idempotency), SDK Guides (Batch Publishing, Stream Consumers, Edge Middleware, Local Testing), API Reference (Publish Event, Manage Routes, Inspect Deliveries, Webhook Endpoints), and Operations (Rate Limits & Quotas, Error Codes). Right 220px column renders the sticky 'On this page' TOC tracking the reader's scroll position with an Ultraviolet left rail.
   Layout: Three-column CSS grid (`260px minmax(0,1fr) 220px`) inside a 1400px container. Below 1180px the right TOC hides; below 900px the left sidebar collapses into a slide-out 'Docs menu' drawer.
   Motion: Active TOC heading highlights automatically via scroll position listener.
2. **Guides-First Quickstart Article, Synced Code Tabs & Interactive Try It Panel** — Opens with a vibrant Graphite + Ultraviolet + Lime hero strip displaying the SDK badge (`[PKG_NAME] v3.4`), Quickstart headline, [TAGLINE], and an inline SVG architecture flow (`Producer -> Edge Router -> Signed Fan-out -> Retry Queue`). Follows with numbered Steps (1. Install `[PKG_NAME]`, 2. Initialize client, 3. Publish & verify an event) using synchronized language tabs (JavaScript, Python, cURL—clicking Python switches every multi-language code block on the page at once and persists to localStorage) inside dark `#1C1E26` frames with `#C3F53C` lime accent lines and one-click Copy buttons. Includes all four styled Callouts (Note, Tip, Warning, Danger), a structured Parameter Table (name, type, required pill, description), and an interactive 'Try it' Request Panel where users edit JSON payload fields (`topic`, `region`, `idempotencyKey`), pick HTTP method/endpoint, and click 'Send mock request' to receive a realistic mocked JSON response with HTTP 202 status badge and simulated latency readout.
   Layout: Single centered reading column (max 760px) with full-width code blocks, responsive parameter tables inside `overflow-x-auto` frames, and a two-pane Request / Response layout inside the Try It widget.
3. **Page Footer: Helpful Vote, Edit Link & Prev / Next Navigation** — Bottom bar with 'Was this page helpful?' Yes / No buttons persisted per page in localStorage (showing a thank-you confirmation once voted), an 'Edit this page on Git' link pointing to the page's Markdown path (e.g. `src/content/docs/quickstart.md`), side-by-side Previous / Next page cards, and a subtle footer carrying the optional [CREDIT] link.
   Layout: Two-column prev/next cards above a compact footer row; stacked vertically on 390px mobile.

### Publish Event API · [BRAND] Docs (`#/docs/api-publish`)
1. **Endpoint Reference, Parameters & Interactive Playground** — Full API reference page for `POST /v3/events` (switches to `POST /v2/dispatch` when version v2 is selected), complete with request/response parameter tables, synced JS/Python/cURL examples, error code callout, and live interactive Try It panel.
   Layout: Rendered inside the same three-column docs shell.

### Changelog · [BRAND] Docs (`#/changelog`)
1. **Versioned Release Timeline** — Structured SDK changelog covering v3.4 (Latest), v3.2, v3.0 (Major), and v2.8 (Maintenance LTS) with filter pills (All, Features, Breaking, Fixes) and clear migration callouts. Uses version tags and release badges only (no calendar dates).
   Layout: Centered 820px timeline with left version badges and right release cards.

### Page Not Found · [BRAND] Docs (`#/404`)
1. **Helpful 404 Fallback** — Graphic 404 card in Graphite, Ultraviolet, and Lime showing the unmatched path, quick links to Quickstart, API Reference, and Changelog, plus a button to launch the Cmd+K heading search modal.
   Layout: Centered card inside the documentation shell.

## Assets
- icon: Install lucide-react (ISC) for sidebar chevrons, callout icons, search, copy, theme toggle, and version indicators.
- font: Install @fontsource/plus-jakarta-sans, @fontsource/inter, and @fontsource/jetbrains-mono (OFL) and import directly in src/main.tsx.
- image: Draw the [BRAND] geometric mark and the Quickstart event-routing architecture diagram as clean inline SVG components.

## Don'ts
- No real documentation platform or SDK brand names anywhere in copy, code, or sample endpoints.
- No calendar dates, months, or four-digit years anywhere on the rendered pages (changelog uses version numbers and release labels like 'Latest' or 'LTS').
- No backend, remote search APIs, or external CDN scripts/fonts; all 18+ Markdown pages bundle locally.
- No source maps in production build (build.sourcemap: false) and keep dist/ under 20 MB.
- No emoji characters used as UI icons or callout markers; use Lucide icons.
- No clip-path reveal tricks hiding sections until scroll.
- No horizontal page overflow at 1440x900 desktop or 390x844 mobile.

---
— Prompt by VibeFather · https://vibefather.ai/t/product-documentation-website · CC BY-NC 4.0 (non-commercial; commercial use needs a VibeFather Pro license) · Request removal: https://vibefather.ai/takedown

Free for personal projects under CC BY-NC 4.0. Commercial use comes with Pro.

DESIGN.md

The design system on its own — colors, type, spacing and motion. Apply this look to a project you already have.

---
name: "Product Documentation Website"
colors:
  paper_white: "#FFFFFF"
  soft_rail: "#F6F7FB"
  graphite_ink: "#1C1E26"
  deep_obsidian: "#12141B"
  ultraviolet_accent: "#6C4CFF"
  lime_highlight: "#C3F53C"
  amber_caution: "#F59E0B"
  crimson_alert: "#E5484D"
typography:
  headings_display: { family: "Plus Jakarta Sans", weights: [600, 700, 800] }
  body_prose_ui: { family: "Inter", weights: [400, 500, 600] }
  code_endpoints_tables: { family: "JetBrains Mono", weights: [400, 500, 600] }
spacing: "Crisp editorial reading grid: 60px sticky top bar, 260px left sidebar, 760px optimal-measure central reading column, 220px right 'On this page' TOC on desktop (1440px); 24px–32px section gaps."
radius: "6px for badges, buttons, and search inputs; 10px for dark graphite code frames, callouts, and interactive Try It panels."
---

# Product Documentation Website — Design System

Apply this design system to an existing project. It describes the look and feel only; for the full site, use prompt.md.

## Colors
- **Paper White** `#FFFFFF` — Primary light-mode reading canvas and header surface
- **Soft Rail** `#F6F7FB` — Sidebar surface, table headers, and callout fills in light mode
- **Graphite Ink** `#1C1E26` — Primary text in light mode and dark code-block / dark-mode base surface
- **Deep Obsidian** `#12141B` — Dark-mode page background with #1C1E26 cards and #F2F4F8 foreground text
- **Ultraviolet Accent** `#6C4CFF` — Active sidebar item, TOC scroll indicator, primary buttons, and interactive links (lightened to #9B85FF in dark mode for AA contrast)
- **Lime Highlight** `#C3F53C` — Code syntax highlights, HTTP 200 status badge inside dark graphite code frames, and active code-tab underline
- **Amber Caution** `#F59E0B` — Warning callouts and v2 deprecation notice pills
- **Crimson Alert** `#E5484D` — Danger callouts and error status codes

## Typography
- **Headings & Display** — Plus Jakarta Sans (OFL), weights 600/700/800. Self-host the font files.
- **Body Prose & UI** — Inter (OFL), weights 400/500/600. Self-host the font files.
- **Code, Endpoints & Tables** — JetBrains Mono (OFL), weights 400/500/600. Self-host the font files.

## Spacing & shape
- Spacing: Crisp editorial reading grid: 60px sticky top bar, 260px left sidebar, 760px optimal-measure central reading column, 220px right 'On this page' TOC on desktop (1440px); 24px–32px section gaps.
- Radius: 6px for badges, buttons, and search inputs; 10px for dark graphite code frames, callouts, and interactive Try It panels.

## Motion
- Smooth 150ms active-indicator glide on sidebar links, synced code tabs, and right-hand TOC highlight.
- Crisp 160ms expand/collapse on sidebar groups and Cmd+K search modal fade.
- Respect prefers-reduced-motion across all transitions and smooth-scroll jumps.

## Imagery
Pure code-drawn technical graphics: geometric ultraviolet/lime SVG logo mark for [BRAND], inline SVG request-pipeline architecture diagram on the Quickstart page, crisp Lucide icons for callouts and controls, and high-contrast dark graphite code frames with lime highlights. No external photos.

## Tone
Clear, direct, engineering-first technical writing with concrete payloads, crisp parameter definitions, and zero marketing filler.

---
— Prompt by VibeFather · https://vibefather.ai/t/product-documentation-website · CC BY-NC 4.0 (non-commercial; commercial use needs a VibeFather Pro license) · Request removal: https://vibefather.ai/takedown

Make it yours

  • For an internal platform team: set BRAND to your platform name, replace the API Reference group with your service endpoints, and keep the Try It panel pointed at your mock payloads.
  • For a startup shipping its first SDK: set PKG_NAME to your npm package, rewrite the Quickstart steps for your install command, and use the changelog timeline for release notes.
  • For a technical writer documenting a public API: keep the three-column shell, swap the seeded Markdown pages for your endpoint guides, and set API_BASE to your real base URL.
  • For a developer-experience lead teaching an event system: keep the architecture diagram and callouts, rename the Core Concepts group to your own topics, and adjust the parameter tables.

Product Documentation Website: questions and answers

How do I change the SDK brand, package name, and API URL in the Product Documentation Website template?

The Product Documentation Website template swaps through four variables: BRAND for the SDK name, PKG_NAME for the lowercase package slug, API_BASE for the endpoint shown in cURL and Try It panels, and TAGLINE for the one-line summary. The default values are RelayMesh, relaymesh, https://api.relaymesh.dev, and a short event-routing summary. Set them once, then rewrite every headline and code sample that references them so the docs stay consistent.

How does the v2 and v3 version switcher work in this documentation template?

The Product Documentation Website template ships a version dropdown that genuinely swaps page prose, code examples, endpoint paths, and parameter tables between v3 (Latest) and v2 (Legacy). Selecting v2 shows an Amber deprecation notice banner and changes the publish endpoint from /v3/events to /v2/dispatch. The active version persists in local storage, so a returning reader lands on the same version they last used.

Can I add my own documentation pages and guides to the Product Documentation Website template?

Yes. The Product Documentation Website template stores 18+ documentation pages as local Markdown files, organized into five guide groups: Getting Started, Core Concepts, SDK Guides, API Reference, and Operations. Adding or editing a page means writing Markdown, not touching React components. The parser handles front matter, headings, callout blocks, numbered steps, parameter tables, and synced code-tab groups, so new pages inherit the same layout.

What does the Try it request panel do on the Product Documentation Website template?

The Try it panel is an interactive request runner inside the Quickstart and API reference pages. Readers edit JSON payload fields such as topic, region, and idempotencyKey, pick an HTTP method and endpoint, then click Send mock request to receive a realistic mocked JSON response with an HTTP 202 status badge and a simulated latency readout. It runs entirely in the browser with no backend or external API calls, so it is safe to host as a static site.

How do the synchronized code tabs and Cmd+K search work in this developer docs template?

The Product Documentation Website template keeps JavaScript, Python, and cURL examples in sync across the whole page: clicking Python switches every multi-language code block at once, and the choice persists in local storage. Each block has a one-click copy button. The Cmd+K search palette indexes every document heading with full keyboard navigation, so readers can jump straight to a section without scrolling the sidebar.

How do I build a product documentation website with AI?

Copy the prompt from this page or run npx vibefather add product-documentation-website, replace [BRAND], [TAGLINE], [API_BASE] and [PKG_NAME] with your own content, and paste it into Claude Code, Codex, Cursor or another AI coding agent. The live demos were built from exactly that text.

Which AI model built the Product Documentation Website demo?

The Event routing SDK docs case was built by Gemini 4 Neon in Antigravity; the Background job queue SDK case was built by GPT-6.2 Sol in Codex. Each build used the published prompt with nothing added, so you can compare the models side by side.

What tech stack and pages does the Product Documentation Website template use?

Product Documentation Website is a 4-page site built with React and Tailwind CSS, with page transitions and micro-interactions. The prompt fixes the stack so every AI tool builds the same kind of project, and the result runs as a static site you can host anywhere.

Can I use the Product Documentation Website template for a client or a business?

The Product Documentation Website prompt and DESIGN.md are free for personal, non-commercial projects under CC BY-NC 4.0. Client work and commercial use need VibeFather Pro, which also includes the source code of the live demo.

Does the Product Documentation Website template work on mobile?

Yes. Every Product Documentation Website build was tested on a phone-sized screen as well as desktop before it went live, checking layout, text size and touch targets. Open the live demo on your phone, or switch the preview on this page to mobile view, to check it yourself.