Skip to content

Commit e610bcd

Browse files
shenxianpengshenxianpeng
authored
Create unified documentation site for commit-check organization (#1)
This PR creates a comprehensive unified documentation site for the commit-check organization that consolidates documentation from both the main `commit-check` tool and the `commit-check-action` GitHub Action into a single, professional hub at `commit-check.github.io`. ## Overview Previously, documentation was scattered across multiple repositories: - `commit-check/commit-check` had Sphinx-based docs at `commit-check.github.io/commit-check/` - `commit-check/commit-check-action` only had README-based documentation This PR establishes `commit-check.github.io` as the central documentation portal for the entire organization. ## What's Added ### 🏗️ Jekyll Site Infrastructure - Complete Jekyll-based documentation site with GitHub Pages deployment - Custom responsive theme with professional navigation - Automated deployment workflow using GitHub Actions - SEO optimization with sitemap generation and proper meta tags ### 📚 Comprehensive Documentation Structure - **Landing Page**: Overview of all commit-check tools with quick access links - **Quick Start Guide**: Step-by-step setup for GitHub Actions, local development, and Git hooks - **Commit Check Tool Documentation** (3 pages): - Main documentation with usage examples and configuration - Detailed CLI arguments reference - Comprehensive configuration guide with examples - **GitHub Action Documentation** (2 pages): - Complete usage guide with workflow examples - Troubleshooting guide for common issues - **404 Error Page**: User-friendly error handling ### 🎨 Design & User Experience - Responsive navigation bar with current page highlighting - Custom CSS styling that matches GitHub's design language - Code syntax highlighting for all examples - Cross-referenced links between related tools and features - Mobile-friendly responsive design ### 🔄 Content Migration & Enhancement - Converted existing RestructuredText documentation to Markdown - Enhanced commit-check tool documentation with additional guides - Expanded GitHub Action documentation beyond the original README - Added practical examples and troubleshooting scenarios - Maintained all existing badges, links, and external references ## Key Features **Unified Experience**: Users can now access all commit-check documentation from a single, professional site rather than navigating between multiple repositories. **Enhanced Discoverability**: The site includes cross-references between tools, helping users discover related features (e.g., linking from CLI tool docs to GitHub Action docs). **Improved Onboarding**: The Quick Start guide provides immediate value for new users across all integration methods. **Professional Presentation**: Custom styling and navigation create a cohesive brand experience for the commit-check organization. ## Technical Implementation The site uses Jekyll with GitHub Pages for automatic deployment. The structure includes: - Custom layouts and includes for consistent theming - SCSS styling for enhanced visual design - Proper permalink structure for SEO - Comprehensive GitHub Actions workflow for CI/CD When merged to main, the site will be automatically deployed to `https://commit-check.github.io` and serve as the official documentation hub for the commit-check organization. This addresses the need for a centralized documentation site as requested in the original issue, providing a single source of truth for all commit-check tools and significantly improving the user experience for developers integrating these tools into their workflows. <!-- START COPILOT CODING AGENT SUFFIX --> <!-- START COPILOT CODING AGENT TIPS --> --- 💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click [here](https://survey3.medallia.com/?EAHeSx-AP01bZqG0Ld9QLQ) to start the survey.
2 parents 80bd973 + 84eaf80 commit e610bcd

File tree

16 files changed

+1476
-2
lines changed

16 files changed

+1476
-2
lines changed

‎.github/workflows/deploy.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Deploy Jekyll Site to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
concurrency:
15+
group: "pages"
16+
cancel-in-progress: true
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- name: Checkout
23+
uses: actions/checkout@v5
24+
25+
- name: Setup Ruby
26+
uses: ruby/setup-ruby@v1
27+
with:
28+
ruby-version: '3.1'
29+
bundler-cache: true
30+
cache-version: 0
31+
32+
- name: Setup Pages
33+
id: pages
34+
uses: actions/configure-pages@v4
35+
36+
- name: Build with Jekyll
37+
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
38+
env:
39+
JEKYLL_ENV: production
40+
41+
- name: Upload artifact
42+
uses: actions/upload-pages-artifact@v3
43+
44+
deploy:
45+
if: github.ref == 'refs/heads/main'
46+
environment:
47+
name: github-pages
48+
url: ${{ steps.deployment.outputs.page_url }}
49+
runs-on: ubuntu-latest
50+
needs: build
51+
steps:
52+
- name: Deploy to GitHub Pages
53+
id: deployment
54+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Jekyll
2+
_site/
3+
.sass-cache/
4+
.jekyll-cache/
5+
.jekyll-metadata
6+
7+
# Ruby
8+
vendor/
9+
.bundle/
10+
Gemfile.lock
11+
12+
# macOS
13+
.DS_Store
14+
15+
# Windows
16+
Thumbs.db
17+
18+
# Logs
19+
*.log
20+
21+
# Temporary files
22+
*~

‎404.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
layout: default
3+
title: Page Not Found
4+
permalink: /404.html
5+
---
6+
7+
# Page Not Found
8+
9+
Sorry, the page you're looking for doesn't exist.
10+
11+
## What you can do:
12+
13+
- **Go to the [Home Page](/)** to start over
14+
- **Check our [Quick Start Guide](quick-start/)** to get started
15+
- **Browse [Commit Check Tool Documentation](commit-check/)**
16+
- **Browse [GitHub Action Documentation](commit-check-action/)**
17+
18+
## Common Links:
19+
20+
- [Configuration Guide](commit-check/configuration/)
21+
- [CLI Arguments](commit-check/cli-args/)
22+
- [Troubleshooting](commit-check-action/troubleshooting/)
23+
24+
## Still need help?
25+
26+
- [Search GitHub Issues](https://github.com/commit-check/commit-check/issues)
27+
- [Join GitHub Discussions](https://github.com/commit-check/commit-check/discussions)
28+
29+
[← Back to Home](/)

‎Gemfile‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
source "https://rubygems.org"
2+
3+
gem "github-pages", group: :jekyll_plugins
4+
gem "jekyll-feed", "~> 0.12"
5+
6+
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
7+
# and associated library.
8+
platforms :mingw, :x64_mingw, :mswin, :jruby do
9+
gem "tzinfo", ">= 1", "< 3"
10+
gem "tzinfo-data"
11+
end
12+
13+
# Performance-booster for watching directories on Windows
14+
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]

‎README.md‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,12 @@
1-
# commit-check.github.io
2-
Commit Check main website, blog, and more
1+
# Commit Check Documentation Site
2+
3+
This repository contains the unified documentation site for the Commit Check organization, hosted at [commit-check.github.io](https://commit-check.github.io).
4+
5+
## Structure
6+
7+
- **commit-check/**: Documentation for the main commit-check tool
8+
- **commit-check-action/**: Documentation for the GitHub Action
9+
10+
## Development
11+
12+
This site is built with Jekyll and automatically deployed via GitHub Pages.

‎_config.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Site settings
2+
title: Commit Check Documentation
3+
description: A powerful tool for enforcing commit metadata standards
4+
url: "https://commit-check.github.io"
5+
baseurl: ""
6+
7+
# Build settings
8+
markdown: kramdown
9+
highlighter: rouge
10+
11+
# Plugins
12+
plugins:
13+
- jekyll-feed
14+
- jekyll-sitemap
15+
16+
# Sass configuration
17+
sass:
18+
style: compressed
19+
20+
# Social links
21+
github_username: commit-check
22+
23+
# Exclude files
24+
exclude:
25+
- node_modules/
26+
- .sass-cache/
27+
- .jekyll-cache/
28+
- gemfile
29+
- gemfile.lock
30+
- vendor/
31+
- README.md

‎_includes/navigation.html‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<nav class="site-nav">
2+
<a href="{{ '/' | relative_url }}" {% if page.url == '/' %}class="current"{% endif %}>Home</a>
3+
<a href="{{ '/quick-start/' | relative_url }}" {% if page.url contains '/quick-start/' %}class="current"{% endif %}>Quick Start</a>
4+
<a href="{{ '/commit-check/' | relative_url }}" {% if page.url contains '/commit-check/' %}class="current"{% endif %}>Commit Check Tool</a>
5+
<a href="{{ '/commit-check-action/' | relative_url }}" {% if page.url contains '/commit-check-action/' %}class="current"{% endif %}>GitHub Action</a>
6+
<a href="https://github.com/commit-check" target="_blank">GitHub</a>
7+
</nav>

‎_layouts/default.html‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
8+
<title>{% if page.title %}{{ page.title | escape }}{% else %}{{ site.title | escape }}{% endif %}</title>
9+
<meta name="description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}">
10+
11+
<link rel="stylesheet" href="{{ '/assets/css/main.css' | relative_url }}">
12+
<link rel="canonical" href="{{ page.url | replace:'index.html','' | absolute_url }}">
13+
14+
<style>
15+
.site-nav {
16+
background: #f8f9fa;
17+
padding: 1rem;
18+
margin-bottom: 2rem;
19+
border-bottom: 1px solid #e9ecef;
20+
}
21+
.site-nav a {
22+
margin-right: 1rem;
23+
text-decoration: none;
24+
color: #007bff;
25+
font-weight: 500;
26+
}
27+
.site-nav a:hover {
28+
text-decoration: underline;
29+
}
30+
.site-nav a.current {
31+
color: #495057;
32+
font-weight: bold;
33+
}
34+
.content {
35+
max-width: 800px;
36+
margin: 0 auto;
37+
padding: 0 1rem;
38+
}
39+
.footer {
40+
margin-top: 3rem;
41+
padding: 2rem 0;
42+
border-top: 1px solid #e9ecef;
43+
text-align: center;
44+
color: #6c757d;
45+
}
46+
</style>
47+
</head>
48+
49+
<body>
50+
{% include navigation.html %}
51+
52+
<div class="content">
53+
<main class="page-content" aria-label="Content">
54+
{{ content }}
55+
</main>
56+
</div>
57+
58+
<footer class="footer">
59+
<p>&copy; {{ site.time | date: '%Y' }} Commit Check. Licensed under the MIT License.</p>
60+
</footer>
61+
</body>
62+
</html>

‎assets/css/main.scss‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
---
2+
---
3+
4+
/* Base styles */
5+
body {
6+
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue", sans-serif;
7+
line-height: 1.6;
8+
color: #333;
9+
margin: 0;
10+
padding: 0;
11+
}
12+
13+
/* Code styling */
14+
pre, code {
15+
font-family: "SFMono-Regular", Consolas, "Liberation Mono", Menlo, Courier, monospace;
16+
background-color: #f6f8fa;
17+
border-radius: 6px;
18+
}
19+
20+
pre {
21+
padding: 16px;
22+
overflow: auto;
23+
border: 1px solid #e1e4e8;
24+
}
25+
26+
code {
27+
padding: 0.2em 0.4em;
28+
font-size: 85%;
29+
}
30+
31+
pre code {
32+
padding: 0;
33+
background-color: transparent;
34+
}
35+
36+
/* Links */
37+
a {
38+
color: #0366d6;
39+
text-decoration: none;
40+
}
41+
42+
a:hover {
43+
text-decoration: underline;
44+
}
45+
46+
/* Headers */
47+
h1, h2, h3, h4, h5, h6 {
48+
margin-top: 24px;
49+
margin-bottom: 16px;
50+
font-weight: 600;
51+
line-height: 1.25;
52+
}
53+
54+
h1 {
55+
font-size: 2em;
56+
border-bottom: 1px solid #eaecef;
57+
padding-bottom: 0.3em;
58+
}
59+
60+
h2 {
61+
font-size: 1.5em;
62+
border-bottom: 1px solid #eaecef;
63+
padding-bottom: 0.3em;
64+
}
65+
66+
/* Lists */
67+
ul, ol {
68+
padding-left: 2em;
69+
}
70+
71+
/* Tables */
72+
table {
73+
border-collapse: collapse;
74+
width: 100%;
75+
margin: 16px 0;
76+
}
77+
78+
th, td {
79+
border: 1px solid #dfe2e5;
80+
padding: 6px 13px;
81+
}
82+
83+
th {
84+
background-color: #f6f8fa;
85+
font-weight: 600;
86+
}
87+
88+
/* Blockquotes */
89+
blockquote {
90+
padding: 0 1em;
91+
color: #6a737d;
92+
border-left: 0.25em solid #dfe2e5;
93+
margin: 0;
94+
}
95+
96+
/* Badges */
97+
img[alt*="badge"] {
98+
margin-right: 4px;
99+
margin-bottom: 4px;
100+
}
101+
102+
/* Navigation improvements */
103+
.site-nav a {
104+
padding: 8px 16px;
105+
border-radius: 6px;
106+
transition: background-color 0.2s;
107+
}
108+
109+
.site-nav a:hover {
110+
background-color: #f1f3f4;
111+
text-decoration: none;
112+
}
113+
114+
.site-nav a.current {
115+
background-color: #e1f5fe;
116+
}

0 commit comments

Comments
 (0)