publish-project-to-github

Package, publish, and verify local web projects as GitHub repositories with GitHub Pages deployment.

6.3k|743|Updated Feb 3, 2026
One-click install
npx skills add https://github.com/MengTo/Skills --skill publish-project-to-github-mengto
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: publish-project-to-github
Source: https://github.com/MengTo/Skills/tree/main/agent-skills/codex/publish-project-to-github
Command: npx skills add https://github.com/MengTo/Skills --skill publish-project-to-github-mengto

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve? Turning a finished local HTML/CSS/JavaScript project into a public GitHub repository involves many error-prone steps: auditing for leaked secrets, writing a credible README, creating the repo safely, configuring GitHub Pages, and verifying the live site actually works. This Skill turns that into a gated, verifiable workflow. ## Core Features & Use Cases - Pre-publication audit: Runs a bundled shell script that scans for API keys, private keys, .env files, absolute user paths, and symlinks before anything is pushed. - Repository packaging and README generation: Selects a clean packaging model for mixed workspaces and builds a project-specific README from a template with real screenshots and run instructions. - GitHub Pages deployment and verification: Configures Pages via the GitHub CLI, polls build status, and verifies the deployed HTTPS URL, asset paths, and interactions in a browser. - Use Case: You finished a Three.js landing page experiment locally and want to open-source it with a live demo. The Skill audits the folder, creates the repo, pushes it, enables Pages, and confirms the public URL renders correctly. ## Quick Start Use the publish-project-to-github skill to audit this project folder, create a public GitHub repository with a README and preview image, enable GitHub Pages, and verify the live site.

Frequently Asked Questions about publish-project-to-github

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I publish a local HTML project to GitHub Pages?▼

Audit the project for secrets, create the repository with the GitHub CLI using gh repo create, then enable Pages via the GitHub API with the main branch root as source. Poll the latest Pages build until it reports built, then open the public URL to verify rendering and interactions.

How to check a project for leaked API keys before pushing to GitHub?▼

Run the bundled audit_public_project.sh script from the project root. It uses ripgrep to detect credential patterns like sk- tokens, GitHub tokens, AWS keys, private key blocks, .env files, and absolute user paths, and blocks publication when issues are found.

Can GitHub Pages host a project with a server or database?▼

No. GitHub Pages only serves static files, so projects requiring server functions, databases, authentication callbacks, or secret runtime variables are incompatible. The Skill explains the blocker and only chooses another host with explicit user authorization.

Why do assets return 404 on my GitHub Pages project site?▼

Project sites are served from a repository subpath like OWNER.github.io/REPOSITORY/, so root-relative URLs such as /assets/preview.jpg resolve against the domain root and break. Use relative URLs like ./assets/preview.jpg and verify capitalization, since the host is case-sensitive.

When should I not force-push to an existing GitHub repository?▼

Never force-push, overwrite a remote, change visibility, or replace an existing Pages configuration without exact user authorization. For existing repositories, inspect the default branch and remote state first, then pull or reconcile divergence deliberately.