deploy-docs

Validate Eleventy documentation builds and prepare GitHub Pages deployment artifacts.

12|2|Updated Jan 27, 2026
One-click install
npx skills add https://github.com/jikig-ai/soleur --skill deploy-docs-jikig-ai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: deploy-docs
Source: https://github.com/jikig-ai/soleur/tree/main/plugins/soleur/skills/deploy-docs
Command: npx skills add https://github.com/jikig-ai/soleur --skill deploy-docs-jikig-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill automates the validation of the documentation build and the preparation of GitHub Pages deployment artifacts.

Core Features & Use Cases

  • Validate Eleventy build by executing npm ci and npx @11ty/eleventy to ensure _site output is generated.
  • Verify presence of critical assets and pages (index.html, agents.html, skills.html, changelog.html, getting-started.html, 404.html, css/style.css, CNAME, sitemap.xml) to guarantee site integrity.
  • Use case: A docs team can run this skill to ensure a new docs version builds cleanly and is ready for GitHub Pages deployment with consistent artifact checks.

Quick Start

Run the deploy-docs workflow to validate the Eleventy build and prepare GitHub Pages-ready output.

Frequently Asked Questions about deploy-docs

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

FAQPage Schema
How do I validate an Eleventy build before deploying to GitHub Pages?

To validate an Eleventy build for GitHub Pages, run npm ci and npx @11ty/eleventy to generate the _site output, then verify critical assets like index.html, sitemap.xml, and css/style.css exist to guarantee site integrity before deployment.

What critical files should be present in my Eleventy docs site output?

Critical files in your Eleventy docs site output include index.html, agents.html, skills.html, changelog.html, getting-started.html, 404.html, css/style.css, CNAME, and sitemap.xml, ensuring complete site integrity for deployment.

Does this docs deployment automation work with my existing GitHub Pages setup?

This docs deployment automation works with GitHub Pages setups using Eleventy to render documentation, executing build validation and preparing reproducible deployment artifacts for your existing repository configuration.

Why does my Eleventy documentation build fail site integrity checks?

Your Eleventy documentation build fails site integrity checks when essential generated pages or assets, such as index.html, 404.html, or CNAME, are missing from the _site output directory after the build process completes.

What is the best way to automate documentation deployment for Eleventy projects?

The best way to automate documentation deployment for Eleventy projects is using a repeatable workflow that validates the build, checks for required output assets, and prepares GitHub Pages-ready artifacts in one consistent run.

Can I use this to prepare GitHub Pages deployment artifacts without manual checks?

Yes, you can use this to prepare GitHub Pages deployment artifacts without manual checks, as it automatically verifies the presence of critical pages and assets like sitemap.xml and CNAME after executing the Eleventy build.