commit bfe8adc4e10e20a136d3c56541adbe0c7f8121b1 Author: Zhongwei Li Date: Sun Nov 30 08:58:16 2025 +0800 Initial commit diff --git a/.claude-plugin/plugin.json b/.claude-plugin/plugin.json new file mode 100644 index 0000000..43fbac4 --- /dev/null +++ b/.claude-plugin/plugin.json @@ -0,0 +1,18 @@ +{ + "name": "common", + "description": "Generic plugin useful for all types of projects", + "version": "1.0.0", + "author": { + "name": "JD Boivin", + "email": "jd@boiv.in" + }, + "commands": [ + "./commands/hello.md", + "./commands/readme.md", + "./commands/gh-pages.md", + "./commands/issue.md" + ], + "hooks": [ + "./hooks/hooks.json" + ] +} \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..40e4c67 --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# common + +Generic plugin useful for all types of projects diff --git a/commands/gh-pages.md b/commands/gh-pages.md new file mode 100644 index 0000000..b871f20 --- /dev/null +++ b/commands/gh-pages.md @@ -0,0 +1,163 @@ +--- +description: Create a professional GitHub Pages (index.html) in docs/ to showcase the project +arguments: + - name: theme + description: Theme to use for the page (dark or light) + required: false + default: dark +--- + +# GitHub Pages Generator Command + +Generate a professional, marketing-focused GitHub Pages documentation site for the current project. + +## Objective + +Create a professional `index.html` file in the `docs/` directory that serves dual purposes: +1. **Marketing page**: Attractive showcase of the project with clear value proposition +2. **Documentation cheatsheet**: Quick reference for features, inputs/outputs, and usage examples + +## Theme Inspiration + +A theme template will be **automatically injected into the context** when you execute this command. The template is selected based on the `theme` argument: + +- **theme=dark** (default): Modern dark theme with gradient accents +- **theme=light**: Clean light theme with purple gradient + +**Important**: The injected template is an inspiration source, not a strict template to copy. Use it to guide the visual style, color palette, and overall aesthetic, but adapt the structure and content to fit the specific project. The goal is to create something that feels similar in style while being tailored to the project's needs. + +## Requirements + +### Structure & Content + +**Note**: Adapt sections based on what's relevant to the project. Not all projects need every section. + +1. **Hero Section** (Required) + - Project name as main heading with **gradient text** (MUST use CSS gradient) + - Clear, concise tagline explaining what the project does + - Call-to-action buttons (GitHub repo, documentation, etc.) + +2. **Features Section** (Required) + - Grid layout showcasing key features + - Icons or visual elements for each feature + - Brief descriptions (1-2 sentences max) + +3. **Usage/Quick Start Section** (Optional - include if project has code examples) + - Practical code examples showing real-world usage + - Multiple workflow examples if applicable (dev, staging, production) + - ALL code examples MUST use syntax highlighting with colored text + +4. **Reference Section** (Optional - include if project has inputs/outputs/parameters) + - Complete inputs/outputs documentation + - Organized in clear categories + - Parameter names, descriptions, and defaults + - Mark required vs optional parameters clearly + +5. **Footer** (Required) + - Links to GitHub repo, issues, releases, documentation + - Author/creator credit + +### Code Highlighting + +**CRITICAL**: All code blocks, inline code, and usage examples MUST use colored syntax highlighting: + +- Use semantic CSS classes for syntax elements (keywords, strings, variables, comments) +- Define color schemes in `