Back to Guides

/gcloud-kit:pages

Generate a GitHub Pages site to display all G-Cloud submission documents.

Overview

Creates a single-page documentation site (docs/index.html) that renders all G-Cloud Kit artifacts in a navigable web interface with Mermaid diagram support and GOV.UK Design System styling.

Usage

/gcloud-kit:pages

Arguments: None required.

Prerequisites

  • At least one service with documents in services/
  • Supplier profile recommended (services/supplier/supplier-profile.md)

Output

docs/
├── index.html          # Main documentation site (SPA)
└── manifest.json       # Document index for navigation

What it does

  1. Scans the repository for all G-Cloud artifacts (supplier profile, service documents, marketing, declaration, market analysis, submission story)
  2. Generates docs/manifest.json with the discovered document structure
  3. Reads the pages template from plugin/templates/pages-template.html
  4. Generates docs/index.html as a single-page application with sidebar navigation, markdown rendering, and Mermaid diagram support
  5. Provides a summary of indexed documents and GitHub Pages setup instructions

Features

  • Sidebar navigation organized by category (Supplier, Services, Declaration, Market Intelligence, Submission)
  • Markdown rendering with syntax highlighting via marked.js
  • Mermaid diagram rendering (flowcharts, Gantt charts, pie charts)
  • GOV.UK Design System styling with system fonts
  • Responsive mobile layout with collapsible sidebar
  • Hash-based URL routing for direct document links
  • Lazy loading and in-memory caching of documents

Enabling GitHub Pages

  1. Go to repository Settings > Pages
  2. Set Source to "Deploy from a branch"
  3. Set Branch to "main" and folder to "/docs"
  4. Save — site will be available at https://{owner}.github.io/{repo}/

Related commands