skills.rest
xhuaustc
xhuaustcCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

generate-codebase-wiki

Generate a static HTML codebase wiki with hierarchical navigation and search.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/xhuaustc/agent-skills --skill generate-codebase-wiki
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: generate-codebase-wiki
Source: https://github.com/xhuaustc/agent-skills/tree/main/skills/generate-codebase-wiki
Command: npx skills add https://github.com/xhuaustc/agent-skills --skill generate-codebase-wiki

SYSTEM DOCUMENTATION & REQUIREMENTS

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

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.

Frequently Asked Questions about generate-codebase-wiki

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

FAQPage Schema
How do I generate a static HTML wiki from my codebase?▼

You generate a static HTML wiki by placing Markdown files in a wiki directory, optionally adding a JSON config for layout, and running the bundled Python build script to produce structured HTML with hierarchical navigation.

What is the best way to document codebase architecture with citations?▼

The best way to document codebase architecture with citations is using a static wiki generator that links documentation pages directly to source files, ensuring evidence-based claims and traceability across the codebase.

Can I use a Python script to build a codebase wiki without external tooling?▼

Yes, you can use a bundled Python script to build a codebase wiki without external tooling. The script parses Markdown files and outputs a static HTML site with client-side search and Mermaid diagram support.

Do I need a JSON config file to structure a large repository wiki?▼

You do not need a JSON config file for small repositories, but adding a JSON config file allows you to quickly customize the section layout and hierarchical navigation for large repository wiki generation.

Does the generated codebase wiki support Mermaid diagrams?▼

Yes, the generated codebase wiki supports Mermaid diagrams. It renders architecture, workflows, and data flows directly within the static HTML pages to help visualize codebase structure.

What are the limitations of using a static wiki for codebase documentation?▼

A limitation of using a static wiki for codebase documentation is that content is generated at build time, meaning it does not automatically reflect real-time code changes without rerunning the Python build script.

Related Skills

davpatel605-beepdavpatel605-beep

code-wiki

Generate structured wiki documentation and Mermaid architecture diagrams from source code.

Community
Advanced
jdevalkjdevalk
93

wp-static-clone

Clone a live WordPress site into a static HTML deployment.

Community
Advanced
majesticlabs-devmajesticlabs-dev
47

mermaid-builder

Generate syntactically valid Mermaid diagrams for flowcharts, sequence, class, state, Gantt, ER, and data lineage.

Official
Advanced
zzafergokzzafergok
1

markdown-to-html-skill

Convert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.

Community
Intermediate