Component Showcase
A reference of all UI components, patterns, and styles used throughout the theme.
Design System
Everything that defines the visual language of the Codex theme. Color tokens, surface elevation, typography, code blocks, and interactive elements.
Color Tokens
Surface Elevation
Typography
Documentation Page Title
Section Heading
Subsection Heading
Label Heading
Good documentation is written for humans first. It anticipates questions, provides context, and guides readers through concepts step by step. Every sentence should earn its place on the page.
Use npm install ghost-cli to get started. Configure with config.production.json.
Bold text, italic text, underlined text, strikethrough text, and linked text within a paragraph.
Code Block
Buttons
Theme Components
Real content rendered through the theme's card partials, pulling live data from your Ghost site.
Doc Cards
Authentication & API Keys
Learn how to generate API keys, authenticate requests, and manage access tokens for the Codex API.
Configuring Search and Navigation
Set up full-text search, sidebar navigation hierarchy, and breadcrumbs to help users find what they need in your documentation.
Kitchen Sink: All Ghost Editor Elements
A comprehensive demonstration of every Ghost editor element styled by the Codex theme — headings, code blocks, tables, callouts, and more.
Why We Built Codex: A Ghost Theme for Documentation Teams
The story behind Codex — why we built a Ghost documentation theme and what makes it different from alternatives.
The ROI of Great Documentation: Why Developer Docs Drive Revenue
Data-backed analysis of how investing in developer documentation reduces support costs, accelerates onboarding, and drives product adoption.
Ghost vs GitBook vs Docusaurus: Documentation Platform Comparison
An honest comparison of the three leading documentation platforms in 2026 — features, pricing, performance, and developer experience.
Tag Cards
Ghost Editor Cards
All Ghost card types rendered inside the content wrapper, exactly as they appear in published posts.
Image Cards
Gallery Card
Embed Cards
Bookmark Card
Callout Cards
card_assets configuration to automatically load CSS and JS only for the cards used on each page, improving performance.
#author will be removed in future Ghost versions. Migrate to #primary_author as soon as possible.
gscan before uploading. Run npx gscan . from your theme directory.
Toggle Cards
How do I install a custom Ghost theme?
Navigate to Ghost Admin > Settings > Design > Change theme and click Upload theme. Select your theme's ZIP file and activate it. Make sure your theme passes gscan validation before uploading.
What is the difference between pages and posts?
Posts are part of your publication's feed and can be tagged, featured, and paginated. Pages are standalone content (like About or Contact) that don't appear in feeds. Both use the same editor but have different templates: post.hbs for posts and page.hbs for pages.
Button Card
Header Cards
Plain (surface background)
Stay in the Loop
Get the latest updates on new features and releases delivered to your inbox.
Accent style with CTA
Subscribe for Full Access
Get premium articles, weekly newsletters, and exclusive deep-dives.
SubscribeBackground image + CTA button
The Future of Publishing
Ghost empowers creators and teams to build professional publications with modern tools.
Get StartedAudio Card
Video Card
File Card
Product Card
Ghost Pro Handbook
The definitive guide to building, customizing, and scaling your Ghost publication. Covers theme development, membership tiers, and performance optimization.
Signup Card
Subscribe to Our Newsletter
Join thousands of developers who receive weekly tutorials, tips, and news about Ghost theme development.
No spam. Unsubscribe anytime.
Content Elements
The best documentation is the documentation that people actually read. Make it clear, concise, and easy to navigate.
This is an aside-style blockquote used for supplementary information, tips, or editorial notes that complement the main content without interrupting the reading flow.
- Unordered list item one
- Unordered list item two with a longer description that wraps to demonstrate how multi-line items behave
- Unordered list item three with bold and linked text
- First ordered item — install Ghost CLI globally
- Second ordered item — run
ghost installin your server directory - Third ordered item — configure
config.production.jsonwith your database credentials
| Property | Type | Default | Description |
|---|---|---|---|
title |
string | null |
The display title of the component |
enabled |
boolean | true |
Whether the component is active |
maxItems |
number | 10 |
Maximum number of items to display |
theme |
string | "auto" |
Color theme: "light", "dark", or "auto" |
Portal & Membership
Everything related to Ghost's membership system: auth flows, subscriptions, pricing, content gating, and account states.
Sign In Form
Welcome back
Sign in to access your documentation.
Sign Up Form
Create your account
Get access to premium documentation
Magic Link Confirmation
Check your inbox
We sent a login link to your email address. Click the link to sign in securely.
Newsletter Subscription
Standalone Newsletter Form
Pricing Tiers
Free
- Access to Getting Started guides
- Community documentation access
- Email newsletter updates
Pro
Full access to all NexusDB documentation, advanced guides, and premium integrations.
- Complete API reference access
- Advanced performance tuning guides
- Premium integration tutorials
- Priority support documentation
- Early access to new features docs
- Architecture pattern deep-dives
Content Gate
State: Logged out
This article is for subscribers
Subscribe to get access to premium documentation, guides, and exclusive resources.
Subscribe NowAlready a member? Sign in
State: Needs upgrade
Member Account States
Nav — Logged out
Sign out
Sign outPortal Trigger Links
Custom Interactions
Theme-specific JS-driven components that go beyond static markup.
Table of Contents
Post content area
The TOC sidebar appears alongside long-form content. It scans h2/h3 headings and builds a navigable list with scroll-spy highlighting. The active heading is underlined with the accent color.
Scroll Reveal
Elements with class .reveal fade in when they enter the viewport. Uses IntersectionObserver with threshold: 0.1.
Share Links
Carousel
Pagination
Theme-Specific Interactions
Code Copy Button
Every code block in post content automatically gets a Copy button in the top-right corner. Clicking it copies the code and shows a brief confirmation.
const ghost = require('@tryghost/content-api');
const api = new ghost({ url: 'https://demo.ghost.io', key: 'your-key', version: 'v5.0' });
Doc Sidebar Navigation
The left sidebar organizes documentation by sections. Each section can be collapsed and expanded. The active page is highlighted with the accent color. On mobile, the sidebar slides in as an overlay.
Reading Progress Bar
A thin progress bar at the top of the page shows how far the reader has scrolled through the document content.
Page Templates
All .hbs template files available in this theme, mapped to their Ghost context or custom route.
Back to Top
A floating button appears after scrolling past the first viewport height. Clicking it smooth-scrolls to the top of the page.