Create unified documentation site for commit-check organization

.github/workflows/deploy.yml

@@ -0,0 +1,54 @@
+name: Deploy Jekyll Site to GitHub Pages
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1'
+          bundler-cache: true
+          cache-version: 0
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v4
+
+      - name: Build with Jekyll
+        run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
+        env:
+          JEKYLL_ENV: production
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+  deploy:
+    if: github.ref == 'refs/heads/main'
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,22 @@
+# Jekyll
+_site/
+.sass-cache/
+.jekyll-cache/
+.jekyll-metadata
+
+# Ruby
+vendor/
+.bundle/
+Gemfile.lock
+
+# macOS
+.DS_Store
+
+# Windows
+Thumbs.db
+
+# Logs
+*.log
+
+# Temporary files
+*~

404.md

@@ -0,0 +1,29 @@
+---
+layout: default
+title: Page Not Found
+permalink: /404.html
+---
+
+# Page Not Found
+
+Sorry, the page you're looking for doesn't exist.
+
+## What you can do:
+
+- **Go to the [Home Page](/)** to start over
+- **Check our [Quick Start Guide](quick-start/)** to get started
+- **Browse [Commit Check Tool Documentation](commit-check/)**
+- **Browse [GitHub Action Documentation](commit-check-action/)**
+
+## Common Links:
+
+- [Configuration Guide](commit-check/configuration/)
+- [CLI Arguments](commit-check/cli-args/)
+- [Troubleshooting](commit-check-action/troubleshooting/)
+
+## Still need help?
+
+- [Search GitHub Issues](https://github.com/commit-check/commit-check/issues)
+- [Join GitHub Discussions](https://github.com/commit-check/commit-check/discussions)
+
+[← Back to Home](/)

Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+gem "github-pages", group: :jekyll_plugins
+gem "jekyll-feed", "~> 0.12"
+
+# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
+# and associated library.
+platforms :mingw, :x64_mingw, :mswin, :jruby do
+  gem "tzinfo", ">= 1", "< 3"
+  gem "tzinfo-data"
+end
+
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]

README.md

@@ -1,2 +1,12 @@
-# commit-check.github.io
-Commit Check main website, blog, and more
+# Commit Check Documentation Site
+
+This repository contains the unified documentation site for the Commit Check organization, hosted at [commit-check.github.io](https://commit-check.github.io).
+
+## Structure
+
+- **commit-check/**: Documentation for the main commit-check tool
+- **commit-check-action/**: Documentation for the GitHub Action
+
+## Development
+
+This site is built with Jekyll and automatically deployed via GitHub Pages.

_config.yml

@@ -0,0 +1,31 @@
+# Site settings
+title: Commit Check Documentation
+description: A powerful tool for enforcing commit metadata standards
+url: "https://commit-check.github.io"
+baseurl: ""
+
+# Build settings
+markdown: kramdown
+highlighter: rouge
+
+# Plugins
+plugins:
+  - jekyll-feed
+  - jekyll-sitemap
+
+# Sass configuration
+sass:
+  style: compressed
+
+# Social links
+github_username: commit-check
+
+# Exclude files
+exclude:
+  - node_modules/
+  - .sass-cache/
+  - .jekyll-cache/
+  - gemfile
+  - gemfile.lock
+  - vendor/
+  - README.md

_includes/navigation.html

@@ -0,0 +1,7 @@
+<nav class="site-nav">
+  <a href="{{ '/' | relative_url }}" {% if page.url == '/' %}class="current"{% endif %}>Home</a>
+  <a href="{{ '/quick-start/' | relative_url }}" {% if page.url contains '/quick-start/' %}class="current"{% endif %}>Quick Start</a>
+  <a href="{{ '/commit-check/' | relative_url }}" {% if page.url contains '/commit-check/' %}class="current"{% endif %}>Commit Check Tool</a>
+  <a href="{{ '/commit-check-action/' | relative_url }}" {% if page.url contains '/commit-check-action/' %}class="current"{% endif %}>GitHub Action</a>
+  <a href="https://github.com/commit-check" target="_blank">GitHub</a>
+</nav>

_layouts/default.html

@@ -0,0 +1,62 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+
+  <title>{% if page.title %}{{ page.title | escape }}{% else %}{{ site.title | escape }}{% endif %}</title>
+  <meta name="description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}">
+
+  <link rel="stylesheet" href="{{ '/assets/css/main.css' | relative_url }}">
+  <link rel="canonical" href="{{ page.url | replace:'index.html','' | absolute_url }}">
+
+  <style>
+    .site-nav {
+      background: #f8f9fa;
+      padding: 1rem;
+      margin-bottom: 2rem;
+      border-bottom: 1px solid #e9ecef;
+    }
+    .site-nav a {
+      margin-right: 1rem;
+      text-decoration: none;
+      color: #007bff;
+      font-weight: 500;
+    }
+    .site-nav a:hover {
+      text-decoration: underline;
+    }
+    .site-nav a.current {
+      color: #495057;
+      font-weight: bold;
+    }
+    .content {
+      max-width: 800px;
+      margin: 0 auto;
+      padding: 0 1rem;
+    }
+    .footer {
+      margin-top: 3rem;
+      padding: 2rem 0;
+      border-top: 1px solid #e9ecef;
+      text-align: center;
+      color: #6c757d;
+    }
+  </style>
+</head>
+
+<body>
+  {% include navigation.html %}
+
+  <div class="content">
+    <main class="page-content" aria-label="Content">
+      {{ content }}
+    </main>
+  </div>
+
+  <footer class="footer">
+    <p>&copy; {{ site.time | date: '%Y' }} Commit Check. Licensed under the MIT License.</p>
+  </footer>
+</body>
+</html>

assets/css/main.scss

@@ -0,0 +1,116 @@
+---
+---
+
+/* Base styles */
+body {
+  font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue", sans-serif;
+  line-height: 1.6;
+  color: #333;
+  margin: 0;
+  padding: 0;
+}
+
+/* Code styling */
+pre, code {
+  font-family: "SFMono-Regular", Consolas, "Liberation Mono", Menlo, Courier, monospace;
+  background-color: #f6f8fa;
+  border-radius: 6px;
+}
+
+pre {
+  padding: 16px;
+  overflow: auto;
+  border: 1px solid #e1e4e8;
+}
+
+code {
+  padding: 0.2em 0.4em;
+  font-size: 85%;
+}
+
+pre code {
+  padding: 0;
+  background-color: transparent;
+}
+
+/* Links */
+a {
+  color: #0366d6;
+  text-decoration: none;
+}
+
+a:hover {
+  text-decoration: underline;
+}
+
+/* Headers */
+h1, h2, h3, h4, h5, h6 {
+  margin-top: 24px;
+  margin-bottom: 16px;
+  font-weight: 600;
+  line-height: 1.25;
+}
+
+h1 {
+  font-size: 2em;
+  border-bottom: 1px solid #eaecef;
+  padding-bottom: 0.3em;
+}
+
+h2 {
+  font-size: 1.5em;
+  border-bottom: 1px solid #eaecef;
+  padding-bottom: 0.3em;
+}
+
+/* Lists */
+ul, ol {
+  padding-left: 2em;
+}
+
+/* Tables */
+table {
+  border-collapse: collapse;
+  width: 100%;
+  margin: 16px 0;
+}
+
+th, td {
+  border: 1px solid #dfe2e5;
+  padding: 6px 13px;
+}
+
+th {
+  background-color: #f6f8fa;
+  font-weight: 600;
+}
+
+/* Blockquotes */
+blockquote {
+  padding: 0 1em;
+  color: #6a737d;
+  border-left: 0.25em solid #dfe2e5;
+  margin: 0;
+}
+
+/* Badges */
+img[alt*="badge"] {
+  margin-right: 4px;
+  margin-bottom: 4px;
+}
+
+/* Navigation improvements */
+.site-nav a {
+  padding: 8px 16px;
+  border-radius: 6px;
+  transition: background-color 0.2s;
+}
+
+.site-nav a:hover {
+  background-color: #f1f3f4;
+  text-decoration: none;
+}
+
+.site-nav a.current {
+  background-color: #e1f5fe;
+}