setup-docs-site

Scaffold a MkDocs site with Material theme and GitHub Actions workflow.

5|Updated Jul 25, 2025

Search Tags:#documentation #github-actions #ci-cd #project-setup #mkdocs #material-theme #docs-scaffold

Ready to run

npx skills add https://github.com/tomzx/agents --skill setup-docs-site

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: setup-docs-site
Source: https://github.com/tomzx/agents/tree/main/skills/setup-docs-site
Command: npx skills add https://github.com/tomzx/agents --skill setup-docs-site

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps teams bootstrap a MkDocs-based documentation site quickly by scaffolding the docs structure, a Material theme, and a GitHub Actions workflow to publish to GitHub Pages, reducing setup time and manual configuration.

Core Features & Use Cases

Scaffold a MkDocs project with the Material theme and initial content structure (docs/ and mkdocs.yml).
Create an autonomous GitHub Actions workflow to build and deploy the site to GitHub Pages.
Non-destructively add missing components without overwriting existing files, enabling incremental improvements.

Quick Start

Run the setup-docs-site skill with a target project root to generate mkdocs.yml, docs/, and a workflows file, without disturbing existing configurations.

Frequently Asked Questions about setup-docs-site

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

FAQPage Schema

How do I bootstrap a MkDocs documentation site with the Material theme?▼

Bootstrapping a MkDocs site is done by automatically scaffolding the docs directory, generating an mkdocs.yml configuration wired to the Material theme, and creating initial content pages for immediate use.

How do I automate publishing MkDocs to GitHub Pages?▼

Automating MkDocs publishing to GitHub Pages is handled by generating a GitHub Actions workflow that builds your site and deploys it automatically upon repository pushes when a GitHub remote is detected.

Can I add a docs scaffold to an existing repository without overwriting files?▼

Yes, you can add a docs scaffold non-destructively. The process creates only missing files and directories, wiring mkdocs.yml, docs/, and the GitHub Actions workflow without disturbing existing configurations.

What is the best way to set up CI/CD for project documentation?▼

The best way to set up documentation CI/CD is using an automated scaffold that configures MkDocs with a Material theme and generates a ready-to-use GitHub Actions workflow for continuous deployment.

Does the MkDocs GitHub Actions workflow require a specific remote to deploy?▼

Yes, the GitHub Actions workflow for deployment is wired into your repository only when a GitHub remote is present, ensuring the automated publishing to GitHub Pages targets the correct project.