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

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

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.

🔍 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

Choose your preferred method:

npx skills add trsoliu/mini-wiki

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

Simply tell your AI Agent:

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

# 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

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 executes plugin logic at specific Hooks (e.g., before_generate, on_export)

• 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

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/

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

DeepWiki

OpenRepoWiki

Qoder Repo Wiki

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! ⭐