Skip to content

Fix GitHub Pages configuration for architect theme#14

Merged
ncipollina merged 1 commit into
mainfrom
fix/github-pages-architect-theme
Jul 9, 2025
Merged

Fix GitHub Pages configuration for architect theme#14
ncipollina merged 1 commit into
mainfrom
fix/github-pages-architect-theme

Conversation

@ncipollina

Copy link
Copy Markdown
Contributor

Problem

GitHub Pages build was failing due to incorrect theme configuration. The theme: architect format doesn't work with GitHub Pages - it requires the remote_theme format.

Solution

Updated the Jekyll configuration to use the proper GitHub Pages theme format and enhanced the styling.

GitHub Pages Theme Fix

  • ✅ Change from theme: architect to remote_theme: pages-themes/architect@v0.2.0
  • ✅ Add jekyll-remote-theme plugin for proper theme loading
  • ✅ Follow official GitHub Pages theme documentation

Enhanced Theme Configuration

  • ✅ Add show_downloads: true to enable GitHub repository download links
  • ✅ Add google_analytics placeholder for future analytics setup
  • ✅ Clean up unnecessary navigation and collections configuration
  • ✅ Streamline Jekyll configuration for better performance

Custom Styling

  • ✅ Create docs/assets/css/style.scss with custom styles
  • ✅ Improve code blocks, tables, and navigation styling
  • ✅ Add custom alert boxes and better typography
  • ✅ Enhance documentation-specific appearance

Solution Structure

  • ✅ Add new CSS file to Visual Studio solution for easy editing
  • ✅ Maintain organized documentation structure in IDE

Test Plan

Expected Outcome

  • GitHub Pages will build successfully with the architect theme
  • Documentation will have a professional, technical appearance
  • Custom styling will enhance readability and navigation
  • Repository download links will be available in the theme header

References

🤖 Generated with Claude Code

## GitHub Pages Theme Fix
- Update _config.yml to use remote_theme instead of theme for GitHub Pages compatibility
- Change from theme: architect to remote_theme: pages-themes/architect@v0.2.0
- Add jekyll-remote-theme plugin for proper theme loading

## Enhanced Theme Configuration
- Add show_downloads: true to enable GitHub repository download links
- Add google_analytics placeholder for future analytics setup
- Clean up unnecessary navigation and collections configuration

## Custom Styling
- Create docs/assets/css/style.scss with custom styles
- Improve code blocks, tables, and navigation styling
- Add custom alert boxes and better typography
- Enhance documentation-specific appearance

## Solution Structure
- Add new CSS file to Visual Studio solution for easy editing
- Maintain organized documentation structure in IDE

This fixes the GitHub Pages build issue caused by using the local theme format
instead of the required remote theme format for GitHub Pages.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@ncipollina
ncipollina requested a review from Copilot July 9, 2025 01:48

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR fixes the GitHub Pages build by switching to the supported remote theme format and adds custom documentation styling.

  • Replace theme: architect with remote_theme: pages-themes/architect@v0.2.0 and add the required plugin
  • Add docs/assets/css/style.scss for improved code blocks, tables, navigation, alerts, and typography
  • Include the new stylesheet in the Visual Studio solution

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
docs/_config.yml Swapped theme for remote_theme, added jekyll-remote-theme and other site settings
docs/assets/css/style.scss New SCSS file with empty front matter and extensive custom styles
LayeredCraft.Cdk.Constructs.sln Added docs\assets\css\style.scss to solution items
Comments suppressed due to low confidence (4)

docs/assets/css/style.scss:1

  • [nitpick] The empty front matter (--- lines) is needed so Jekyll will process this SCSS file. Consider adding a brief comment explaining its purpose to avoid confusion.
---

docs/_config.yml:8

  • [nitpick] Leaving this key with no value may trigger warnings during build. You can comment it out or set a placeholder string until you have a real tracking ID.
google_analytics: # Add your tracking ID if needed

docs/_config.yml:16

  • Make sure to add gem 'jekyll-remote-theme' to your Gemfile so that Jekyll can load this plugin; otherwise the remote_theme setting won’t be applied.
  - jekyll-remote-theme

docs/assets/css/style.scss:4

  • [nitpick] Verify that site.theme is still defined when using remote_theme. If not, consider importing the theme’s main stylesheet explicitly or using the path from the remote theme package.
@import "{{ site.theme }}";

@ncipollina
ncipollina merged commit 35c60ed into main Jul 9, 2025
1 check passed
@ncipollina
ncipollina deleted the fix/github-pages-architect-theme branch July 9, 2025 01:50
@ncipollina
ncipollina restored the fix/github-pages-architect-theme branch July 9, 2025 01:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants