Transform your codebase into professional-grade, structured documentation with AI 🚀

📖 中文文档 · 🐛 Report Bug · ✨ Request Feature

---

✨ What is Mini-Wiki?

Mini-Wiki is a skills.sh compatible skill package that empowers AI Agents to deeply analyze your codebase and generate professional-grade, structured Wiki documentation with diagrams, cross-links, and detailed explanations — effortlessly.

💡 Before Mini-Wiki Writing docs manually is tedious 📝 Documentation gets outdated quickly 😩 No architecture diagrams 📊 Code references are disconnected 🔗

🎉 After Mini-Wiki AI generates professional-grade docs ✨ Incremental updates keep docs fresh 🔄 Beautiful Mermaid diagrams 📈 Code blocks link to source 🎯 Deep code analysis for detailed content 🔬 Cross-linked documentation network 🔗

---

🎯 Features

🔍 Smart Analysis Auto-detect tech stack and module structure	🔄 Incremental Update Only update docs for changed files	📊 Architecture Diagrams Auto-generate Mermaid dependency graphs
🔗 Code Links Code blocks link directly to source	🌐 Multi-language Support Chinese and English Wiki	🔌 Plugin System Extend with custom plugins

---

🚀 Quick Start

Installation

Choose your preferred method:

📦 Option 1: Using npx (Recommended)

npx skills add trsoliu/mini-wiki

📥 Option 2: Download .skill file

Download mini-wiki.skill from Releases and place it in your skills directory.

📂 Option 3: Clone repository

git clone https://github.com/trsoliu/mini-wiki.git

Usage

Simply tell your AI Agent:

🤖 "generate wiki"
🤖 "create project docs"  
🤖 "update wiki"

Update

Already installed? Update to the latest version:

📦 npx (Recommended)

npx skills update trsoliu/mini-wiki

📂 Git clone

cd mini-wiki && git pull origin main

📥 .skill file

Re-download from Releases

Plugin Commands

# Natural Language
📋 "list plugins"
📦 "install plugin <source>"
📦 "install <owner/repo>"  (GitHub shorthand)
🔄 "update plugin <name>"
✅ "enable plugin <name>"
❌ "disable plugin <name>"

# CLI Direct Usage
python scripts/plugin_manager.py list
python scripts/plugin_manager.py install <source>
python scripts/plugin_manager.py update <name>
python scripts/plugin_manager.py enable <name>

Installation Sources:

• GitHub: owner/repo (e.g., vercel-labs/agent-skills)
• URL: https://example.com/plugin.zip
• Local: ./plugins/my-plugin

How Plugins Work

Mini-Wiki uses an Instruction-based Plugin System. When you run a task:

1. AI reads plugins/_registry.yaml
2. AI reads instructions from PLUGIN.md of enabled plugins
3. AI applies plugin guidance (text-only) at specific Hooks (e.g., before_generate, on_export)

Execution model (safety):

• Plugins are instruction-only; the agent does not execute plugin code or scripts.
• Any CLI commands in PLUGIN.md are for humans only and must not be executed by the agent.

Built-in Plugins

• code-complexity: Code health & complexity analysis
• paper-drafter: Generate academic paper drafts (LaTeX/IMRaD)
• repo-analytics: Multi-dimensional Git analytics & health scoring
• patent-generator: Professional patent disclosure generator
• api-doc-enhancer: Deep semantic API documentation
• changelog-generator: Generate changelog from git
• diagram-plus: Enhanced Mermaid diagrams
• i18n-sync: Multi-language sync
• docusaurus-exporter: Export to Docusaurus
• gitbook-exporter: Export to GitBook

---

📁 Output Structure

All content is generated to .mini-wiki/ directory:

.mini-wiki/
├── 📄 config.yaml           # Configuration
├── 📂 cache/                 # Incremental cache
├── 📂 wiki/                  # Wiki content
│   ├── index.md
│   ├── architecture.md
│   ├── modules/
│   └── api/
└── 📂 i18n/                  # Multi-language support
    ├── en/
    └── zh/

Tip

It is recommended to add .mini-wiki/ to your .gitignore file to avoid committing generated content to your repository.

---

🏗️ Skill Structure

mini-wiki/
├── 📄 SKILL.md              # Main instructions (English)
├── 📂 scripts/              # Python utilities
├── 📂 references/           # Prompts, templates, i18n
├── 📂 assets/               # Config templates
└── 📂 plugins/              # Plugin directory
    ├── _registry.yaml
    └── _example/

---

❓ FAQ

Will updating Mini-Wiki delete my existing docs?

No. Updating Mini-Wiki (the skill/plugin itself) only updates the generation rules and templates. It does NOT automatically delete or modify any existing documentation.

npx skills update trsoliu/mini-wiki  # Only updates Mini-Wiki code

How do I upgrade low-quality docs generated by older versions?

Use these commands to upgrade existing documentation:

Command	Behavior
generate wiki	Incremental update - only updates changed files
upgrade wiki	Detects & upgrades low-quality docs, preserves good ones
refresh all wiki	Regenerates everything (backs up first)

Quality is assessed automatically:

• basic (< 8 sections, no diagrams) → 🔴 Needs upgrade
• standard (8-12 sections, 1 diagram) → 🟡 Optional upgrade
• professional (13+ sections, 2+ diagrams) → ✅ Keep as-is

Will my custom content be preserved during upgrade?

Yes. Content marked with <!-- user-content --> is preserved:

## My Custom Section
<!-- user-content -->
This content will NOT be overwritten during upgrade.
<!-- /user-content -->

Additionally, all docs are backed up to cache/backup/ before any upgrade.

How do I check the quality of my existing docs?

Tell your AI Agent:

🤖 "check wiki quality"
🤖 "检查 wiki 质量"

This generates a quality assessment report showing which docs need upgrading.

---

🙏 Inspired By

DeepWiki

OpenRepoWiki

Qoder Repo Wiki

---

📄 License

This project is licensed under the Apache-2.0 License.

---

💬 Contact

Made with ❤️ by trsoliu

WeChat: trsoliu

---

⭐ Star this repo if you find it helpful! ⭐