mini-wiki

Generate cross-linked Markdown project wikis from code and design assets.

115|11|Updated Jan 26, 2026
One-click install
npx skills add https://github.com/trsoliu/mini-wiki --skill mini-wiki
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mini-wiki
Source: https://github.com/trsoliu/mini-wiki/tree/main
Command: npx skills add https://github.com/trsoliu/mini-wiki --skill mini-wiki

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires pyyaml, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

Mini-Wiki addresses the challenge of turning evolving codebases into up-to-date, structured documentation that AI agents can consume. It creates cross-linked Markdown docs with diagrams and API references from code, design files, and images. It enables incremental updates and multi-language output to keep documentation aligned with the project.

Core Features & Use Cases

  • Deep code analysis and smart structure discovery
  • Mermaid diagrams for architecture and data flows
  • Cross-linked documentation network with code blocks linking to sources
  • Incremental updates and multi-language support

Quick Start

To start, instruct your AI agent to generate a wiki for the current project, and it will produce a .mini-wiki/wiki repository with a full homepage, architecture, modules, and API docs.

Frequently Asked Questions about mini-wiki

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

FAQPage Schema
How do I generate project wiki documentation from code automatically?

To generate project wiki documentation automatically, instruct your AI agent to analyze the repository structure and render cross-linked Markdown content with Mermaid diagrams. This produces a structured .mini-wiki repository containing the homepage, architecture, and API docs.

What is the best way to keep Markdown documentation aligned with an evolving codebase?

Keeping Markdown documentation aligned with an evolving codebase requires incremental updates that re-analyze code and design assets. The Skill supports incremental updates and multi-language output to ensure interconnected documentation stays current with project changes.

Can I generate Mermaid diagrams for architecture and data flows from my repository?

Yes, you can generate Mermaid diagrams for architecture and data flows directly from your repository. The Skill performs deep code analysis to discover module structures and renders Mermaid diagrams that visualize architecture and data flows within the Markdown docs.

Does the generated wiki support cross-linking to source code for AI agents?

The generated wiki supports cross-linking to source code for AI agents. It creates a cross-linked documentation network where code blocks link directly to source files, enabling AI agents to load up-to-date documentation into context for offline analysis.

Do I need PyYAML to create multi-language project documentation from code?

Yes, you need PyYAML installed to create multi-language project documentation from code. PyYAML is the required dependency for the Skill to parse configurations and render multi-language Markdown output with API references and cross-links.