Ghost documentation theme

Ghost documentation theme is a professional Ghost theme for SaaS documentation portals, help centers, product knowledge bases, API references, customer support resources, FAQs, changelogs, and troubleshooting libraries. It includes a search-first documentation homepage, category browsing, sticky sidebar navigation, article table of contents, code syntax highlighting, copyable code blocks, searchable FAQ sections, changelog and troubleshooting templates, dark mode, customizable Ghost theme settings, responsive layouts, Docker setup, and GitLab CI/CD configuration.

General Features

• Ready for Ghost 5.0 or later
• Built for SaaS documentation and product knowledge bases
• Modern help center and docs portal design
• Lightweight Handlebars theme structure
• Fully responsive desktop, tablet, and mobile layout
• Mobile sidebar menu toggle
• Sticky documentation sidebar
• Collapsible sidebar navigation sections
• Saved sidebar section state with localStorage
• Dark mode toggle with saved reader preference
• Modern browser support
• Ghost GScan compatible theme structure
• SEO-friendly Ghost template structure
• Responsive image sizes configured
• Ghost card assets enabled
• Custom documentation homepage
• Custom FAQ page template
• Custom changelog page template
• Custom troubleshooting page template
• Dockerfile included
• GitLab CI/CD configuration included

Ghost Built-In Features Supported

• Posts
• Pages
• Tags
• Public tag directory queries
• Primary tag in post cards
• Post excerpts
• Post feature images
• Page feature images
• Tag archive pages
• Reading time
• Published date display
• Last updated date display
• Previous and next post navigation
• Related posts by primary tag
• Publication title
• Publication logo
• Secondary navigation in the footer
• Ghost Content API integration for search
• Koenig editor content
• Normal, wide, and full-width editor card support through Ghost content
• Ghost card assets support

Homepage Features

• Search-first documentation hero
• Configurable hero title
• Configurable hero description
• Configurable hero search placeholder
• Documentation workspace kicker
• Version badge display
• Browse docs shortcut link
• Latest updates shortcut link
• Homepage feature stats for search, dark mode, and code snippets
• Browse by Category section
• Configurable category section title
• Automatic category cards from public Ghost tags
• Tag feature image support for category icons
• Fallback category icon when no tag image exists
• Category description display
• Category post count display
• Theme feature value strip
• Recent updates section
• Configurable recent updates title
• Recent posts list with date, title, and excerpt

Documentation Article Features

• Dedicated documentation article layout
• Breadcrumb navigation
• Article title header
• Article tag links
• Last updated metadata
• Reading time metadata
• Sticky table of contents sidebar
• Automatic table of contents generated from article headings
• Active table of contents state while scrolling
• Syntax highlighting with Prism
• Code block language labels
• Copy button for code blocks
• Helpful feedback widget
• Thank-you message after feedback
• Previous article navigation
• Next article navigation
• Related articles by primary tag

Search Features

• Search modal interface
• Header search button
• Homepage hero search input trigger
• Ghost Content API powered search index
• Configurable Content API key theme setting
• Search across post titles and excerpts
• Highlighted search query matches
• Tag labels inside search results
• Empty search state
• Unconfigured search state message
• Search unavailable state message
• Backdrop click to close
• Escape key to close
• Command/Ctrl + K keyboard shortcut

Sidebar Navigation Features

• Sticky documentation sidebar
• Getting Started section
• API Reference section
• Guides section
• Troubleshooting section
• Resources section
• Configurable sidebar section labels
• Automatic post lists by documentation tags
• Active article highlighting
• Collapsible navigation groups
• Saved expanded and collapsed state
• Resource links for changelog, FAQ, and troubleshooting pages

Custom Pages

• Default page template
• Post template
• Tag archive template
• Custom FAQ template
• Custom changelog template
• Custom troubleshooting template
• Documentation homepage template

FAQ Features

• Custom FAQ page layout
• FAQ page search input
• Client-side FAQ filtering
• Accordion question and answer layout
• FAQ grouping by Ghost tags
• General, account, billing, and technical FAQ category support
• Contact support call-to-action section

Changelog Features

• Custom changelog timeline page
• Configurable changelog title
• Configurable changelog description
• Automatic changelog entries from posts tagged changelog
• Changelog publish date display
• Feature badge support
• Improvement badge support
• Bug fix badge support
• Breaking change badge support
• Changelog excerpt display
• Read more links for full changelog posts

Troubleshooting Features

• Custom troubleshooting guide template
• Quick navigation cards
• Installation issues section
• Configuration section
• Performance section
• Common errors section
• Automatic troubleshooting articles from Ghost tags
• Troubleshooting article excerpts
• View solution links

Tag Archive Features

• Custom tag archive header
• Tag feature image support
• Fallback tag icon
• Tag description display
• Post count display
• Responsive post card grid
• Post card feature image support
• Primary tag badge
• Post excerpt display
• Published date metadata
• Reading time metadata
• Pagination support

Design & Branding Options

• Ghost publication logo support
• Ghost publication title fallback
• Custom Home navigation label setting
• Optional extra navbar link label setting
• Optional extra navbar link URL setting
• Optional navbar CTA label setting
• Optional navbar CTA URL setting
• Version badge visibility toggle
• Custom version label setting
• Custom hero title setting
• Custom hero description setting
• Custom hero search placeholder setting
• Custom category section title setting
• Custom recent updates title setting
• Custom sidebar section label settings
• Custom changelog title setting
• Custom changelog description setting
• Content API key setting for search

JavaScript Enhancements

• Dark mode toggle
• Saved theme preference
• Automatic table of contents generation
• Table of contents active section tracking
• Code block wrapper and copy behavior
• Ghost Content API search loading
• Search result rendering
• Search text highlighting
• Collapsible sidebar navigation
• Saved sidebar state
• Article feedback widget
• FAQ accordion behavior
• FAQ live search filtering
• Mobile sidebar toggle
• Header scroll elevation effect

Performance & Testing

• Lightweight Handlebars templates
• Minimal vanilla JavaScript enhancements
• No frontend framework dependency
• Responsive CSS layout behavior
• Responsive Ghost image size configuration included
• Ghost card assets enabled
• Prism syntax highlighting included locally
• GScan validation support

Compatibility Notes

• Requires Ghost 5.0 or later
• Designed for modern desktop and mobile browsers
• Uses Ghost Content API for client-side search
• Requires a Ghost Content API key to enable search results
• Uses Ghost Design & branding custom settings
• Uses Ghost tags to populate categories, sidebar sections, FAQ groups, changelog entries, and troubleshooting sections
• Uses Ghost secondary navigation in the footer
• Docker deployment setup included
• GitLab CI/CD deployment setup included