Create Jekyll-based static website for documentation#2
Merged
leandroebner merged 9 commits intomainfrom Dec 15, 2025
Merged
Conversation
Added initial documentation for HOMatE.club project.
This document outlines the utilized log syntax and includes a history section for previous versions.
Added badges for website and Mastodon follow.
There was a problem hiding this comment.
Pull request overview
This PR establishes a Jekyll-based documentation website for the HOMatE.club project, providing comprehensive setup for a GitHub Pages deployment with custom domain support, branding, and dynamic status tracking.
Key Changes
- Created Jekyll site configuration with custom theming and logo for the HOMatE.club brand
- Added documentation pages including main landing page, status tracking page, and syntax reference
- Set up custom domain (
homate.club) for GitHub Pages deployment
Reviewed changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
docs/_config.yml |
Jekyll configuration with minimal theme, logo, and site metadata |
docs/_layouts/default.html |
Custom HTML layout template extending minimal theme |
docs/assets/css/style.scss |
Stylesheet to hide gist metadata in embedded content |
docs/assets/logo.svg |
SVG logo file for the HOMatE.club branding |
docs/README.md |
Main landing page with project overview and navigation |
docs/status/README.md |
Status page embedding a GitHub gist for live updates |
docs/status/syntax.md |
Documentation for log format used in status tracking |
docs/CNAME |
Custom domain configuration for GitHub Pages |
README.md |
Updated with badges and enhanced header |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces the initial setup for the "HOMatE.club" documentation website, providing both the content and configuration needed for a Jekyll-based static site. The changes include documentation landing pages, site configuration, theming, and a system for tracking the status and history of the mate-lemonade project.
Documentation and Content:
docs/README.md, describing the project, its status, and roadmap.docs/status/README.md) that will display the current availability of the lemonade, including an embedded gist for live updates.docs/status/syntax.md) to document the log format used for tracking history and status.Jekyll Site Configuration and Theming:
docs/_config.yml), a custom layout (docs/_layouts/default.html), and a stylesheet (docs/assets/css/style.scss) to define the site's appearance and structure, including logo, theme, and metadata. [1] [2] [3]CNAMEfile pointing tohomate.club.Readme and Project Badges:
README.mdto include project badges, links, and a more informative header.