docs

Organize GitHooks documentation pages with MkDocs and GitHub Actions deployment.

9|Updated Apr 12, 2020

Search Tags:#deployment #docs #mkdocs #documentation-management #docs-site #mkdocs-material #githooks

Ready to run

npx skills add https://github.com/Wtyd/githooks --skill docs-wtyd

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/Wtyd/githooks/tree/main/.claude/skills/docs
Command: npx skills add https://github.com/Wtyd/githooks --skill docs-wtyd

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Gestión de la documentación externa de GitHooks (MkDocs + Material for MkDocs). Usa esta skill cuando el usuario quiera añadir, modificar o reorganizar páginas de documentación, actualizar el sitio de docs, añadir una guía, documentar una feature nueva, o cuando mencione "docs", "documentación", "mkdocs", "página de docs".

Core Features & Use Cases

Flujo de gestión de documentación estructurada con MkDocs y Material for MkDocs.
Actualización del sitio de docs y despliegue en GitHub Pages.
Guías prácticas y documentación de nuevas features.

Quick Start

Edita las páginas de docs/ para reflejar los cambios y sube los commits para activar el flujo de despliegue.

Frequently Asked Questions about docs

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

FAQPage Schema

How do I manage external documentation using MkDocs and Material for MkDocs?▼

MkDocs documentation management involves organizing external project pages by updating the docs directory and leveraging the MkDocs config, yielding a publish-ready site using Material for MkDocs.

What is the best way to deploy an MkDocs site to GitHub Pages?▼

Deploying an MkDocs site to GitHub Pages requires pushing commits to trigger the GitHub Actions deployment workflow, resulting in an automatically published documentation site.

Can I use GitHub Actions to automate documentation deployment for MkDocs?▼

Yes, you can use GitHub Actions to automate MkDocs documentation deployment by pushing commits, which triggers the configured workflow and publishes the updated docs site to GitHub Pages.

How do I add or reorganize guides and migration notes in a docs site?▼

Adding or reorganizing guides and migration notes in a docs site requires editing the pages within the docs directory, ensuring structural compliance with the MkDocs config and directory layout.

Do I need GitHooks to manage and publish documentation with MkDocs?▼

You need GitHooks specifically to manage its external documentation structure using MkDocs and Material for MkDocs, ensuring the docs directory layout and GitHub Actions deployment workflow remain compliant.