Skip to content

tobegit3hub/githubpage-builder

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 

Repository files navigation

githubpage-builder

A Claude Code skill to generate static project websites with GitHub Pages.

Overview

This skill helps you build a beautiful static documentation site for any repository and deploy it via GitHub Pages. It reads your project's README and source files, then generates a ready-to-deploy site in the ./docs directory.

Features

  • Generate a static site from your repository's README.md and source code
  • Multiple framework options: single-page HTML or multi-page with navigation
  • Theme selection for different visual styles
  • Automatic content extraction from source files
  • Output ready for GitHub Pages deployment

Installation

Add this skill to your Claude Code environment:

claude skill add tobegit3hub/githubpage-builder

Usage

Invoke the skill in Claude Code:

/githubpage-builder

The skill will guide you through:

  1. Choosing an output directory (default: ./docs)
  2. Selecting a framework (single HTML page or structured site)
  3. Picking a theme
  4. Generating content from your project files

GitHub Pages Setup

After generating the site, enable GitHub Pages in your repository settings:

  1. Go to Settings > Pages
  2. Set the source to Deploy from a branch
  3. Select the branch and /docs folder
  4. Save and your site will be live

License

Apache License 2.0

About

The skill to generate staic project webiste with github page

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors