Skills
.Work. You
Rest

generate-codebase-wiki

Community

Auto-create a comprehensive codebase wiki.

Authorxhuaustc
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This skill helps you create a structured static HTML documentation wiki for the current codebase, enabling quick access to architecture, features, and development guidelines.

Core Features & Use Cases

  • Structured Wiki Generation: Analyze a repository and produce a multi-level documentation wiki with hierarchical navigation and evidence-based content.
  • Bundled Build Script: Use the included scripts/build_wiki.py to generate the wiki site without external tooling.
  • Diagram Support: Render Mermaid diagrams for architecture, workflows, and data flows in the wiki.
  • Citation-Driven Documentation: Generate pages with citations to source files to support claims.
  • Quick Customization: Optionally configure wiki structure with a JSON config file for large repos.

Quick Start

Place Markdown wiki files under wiki/, optionally add wiki.json for section layout, then run: python wiki/scripts/build_wiki.py -i wiki/ --title "Codebase Wiki" Open wiki/html/index.html to view the generated docs.

Dependency Matrix

Required Modules

None required

Components

scriptsassets

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: generate-codebase-wiki
Download link: https://github.com/xhuaustc/agent-skills/archive/main.zip#generate-codebase-wiki

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.