mkdocs-site-generator

Generate MkDocs documentation sites with GitHub Pages CI/CD for TypeScript/Node.js codebases.

Updated Mar 7, 2026

Search Tags:#typescript #ci/cd #documentation #codebase analysis #github pages #mkdocs

Ready to run

npx skills add https://github.com/Peleke/hunter --skill mkdocs-site-generator

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: mkdocs-site-generator
Source: https://github.com/Peleke/hunter/tree/main/skills/mkdocs-site-generator
Command: npx skills add https://github.com/Peleke/hunter --skill mkdocs-site-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill automates the creation and deployment of comprehensive documentation sites using MkDocs, complete with GitHub Pages CI/CD, for TypeScript/Node.js projects.

Core Features & Use Cases

Automated Site Generation: Creates a full MkDocs structure, configuration, and content.
Codebase Analysis: Discovers project identity, API surface, and architecture.
CI/CD Integration: Sets up GitHub Actions for automatic deployment.
Use Case: You've just finished a new TypeScript library and need professional documentation. This Skill will analyze your codebase, generate the necessary MkDocs configuration and content, and set up a workflow to deploy it to GitHub Pages.

Quick Start

Use the mkdocs-site-generator skill to create a new MkDocs documentation site for the current project.

Frequently Asked Questions about mkdocs-site-generator

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

FAQPage Schema

How do I generate MkDocs documentation for a TypeScript codebase?▼

To generate MkDocs documentation for a TypeScript codebase, this Skill analyzes your project's API surface and architecture, scaffolds the configuration, and creates site content automatically. It extracts project identity to build a structured documentation site without manual writing.

How do I set up GitHub Pages CI/CD for my MkDocs site?▼

Setting up GitHub Pages CI/CD for an MkDocs site involves configuring GitHub Actions workflows for automatic deployment. This integrates version control with automated deployment pipelines, ensuring your documentation site updates whenever you push changes to your repository.

Can I automatically analyze my Node.js project to create API documentation?▼

Yes, you can automatically analyze a Node.js project to create API documentation by running a codebase analysis process. This mechanism discovers your project identity, API surface, and architecture, then uses that extracted data to scaffold MkDocs configuration and generate matching content.

What is the best way to automate project documentation deployment for TypeScript libraries?▼

Automating project documentation deployment for TypeScript libraries is best achieved by generating a full MkDocs structure paired with GitHub Actions. This method handles site generation and continuous deployment to GitHub Pages, satisfying version control integration and automated pipeline requirements.

Do I need manually written content to build an MkDocs site with this automated approach?▼

No, you do not need manually written content to build an MkDocs site with this automated approach. The process analyzes your existing TypeScript codebase to discover its architecture and API surface, scaffolding the configuration and generating the documentation content automatically.