mini-wiki

Solid

Automatically generate **professional-grade** structured project Wiki from documentation, code, design files, and images. Use when: - User requests "generate wiki", "create docs", "create documentation" - User requests "update wiki", "rebuild wiki" - User requests "list plugins", "install plugin", "manage plugins" - Project needs automated documentation generation Features: - Smart project structure and tech stack analysis - **Deep code analysis** with semantic understanding - **Mermaid diagrams** for architecture, data flow, dependencies - **Cross-linked documentation** network - Incremental updates (only changed files) - Code blocks link to source files - Multi-language support (zh/en) - **Plugin system for extensions** For Chinese instructions, see references/SKILL.zh.md

Data & Documents 108 stars 11 forks Updated 3 weeks ago MIT

Install

View on GitHub

Quality Score: 85/100

Stars 20%
68
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Wiki Generator Generate **professional-grade** structured project Wiki to `.mini-wiki/` directory. > **核心原则**:生成的文档必须 **详细、结构化、有图表、相互关联**,达到企业级技术文档标准。 ## 📋 Documentation Quality Standards **CRITICAL**: All generated documentation MUST meet these standards: ### Content Depth - Every topic must have **complete context** - no bare lists or skeleton content - Descriptions must be **detailed and specific** - explain WHY and HOW - Must include **working code examples** with expected output - Must document **edge cases, warnings, common pitfalls** ### Structure Requirements - Use **hierarchical headings** (H2/H3/H4) for clear information architecture - Important concepts in **tables** for quick reference - Processes visualized with **Mermaid diagrams** - **Cross-links** between related documents ### Diagram Requirements (minimum 2-3 per document) | Content Type | Diagram Type | |--------------|--------------| | Architecture | `flowchart TB` with subgraphs | | Data/Call flow | `sequenceDiagram` | | State changes | `stateDiagram-v2` | | **Class/Interface** | `classDiagram` with properties + methods | | Dependencies | `flowchart LR` | ### 🔴 MANDATORY: Source Code Traceability **Every section MUST include source references** at the end: ```markdown **Section sources** - [filename.ts](file://path/to/file.ts#L1-L50) - [another.ts](file://path/to/another.ts#L20-L80) **Diagram sources** - [architecture.ts](file://src/architecture.ts#L1-L100) ``` ### 🔴 MANDATORY: Dynamic Qua...

Details

Author
trsoliu
Repository
trsoliu/mini-wiki
Created
3 months ago
Last Updated
3 weeks ago
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category

Data & Documents Listed

chinese-copyright-application

用于生成中国软件著作权申请材料的完整工具包。支持从项目代码、文档等自动提取信息,生成软件著作权登记申请表、源代码文档(前后各30页)、用户手册和设计说明书,并自动转换为PDF文件。适用于微信小程序、Web应用、移动App、桌面应用等各类软件项目。当用户需要申请中国软件著作权时使用此skill。

138 Updated 3 months ago
na57
Data & Documents Listed

auto-redbook

小红书笔记素材创作技能��当用户需要创建小红书笔记素材时使用这个技能。技能包含:根据用户的需求和提供的资料,撰写小红书笔记内容(标题+正文),生成图片卡片(封面+正文卡片,支持多种样式主题),支持批量创作多篇笔记。

42 Updated 3 months ago
zhangpeicheng8788-ux
API & Backend Featured

api-doc-generator

Generate API documentation from source code, supporting REST APIs, GraphQL, and various documentation formats.

528 Updated today
JackyST0
AI & Automation Solid

spec-writer

Generate structured software specifications for features, bug fixes, and products. Use when the user wants to create a spec, PRD, feature brief, requirements document, or when starting any new implementation that needs a specification first. Invoke via /spec-writer or when the user says "write a spec", "spec this out", "create a spec", "I need a spec for...", or describes a feature they want to build. Produces adaptive-complexity specs with Job Stories, Gherkin acceptance criteria, and three-tier boundaries. Output is a markdown file ready for agent execution or human review.

44 Updated 2 months ago
SamJHudson01
AI & Automation Solid

mermaid-studio

Expert Mermaid diagram creation, validation, and rendering with dual-engine output (SVG/PNG/ASCII). Supports all 20+ diagram types including C4 architecture, AWS architecture-beta with service icons, flowcharts, sequence, ERD, state, class, mindmap, timeline, git graph, sankey, and more. Features code-to-diagram analysis, batch rendering, 15+ themes, and syntax validation. Use when users ask to create diagrams, visualize architecture, render mermaid files, generate ASCII diagrams, document system flows, model databases, draw AWS infrastructure, analyze code structure, or anything involving "mermaid", "diagram", "flowchart", "architecture diagram", "sequence diagram", "ERD", "C4", "ASCII diagram". Do NOT use for non-Mermaid image generation, data plotting with chart libraries, or general documentation writing.

4,426 Updated 4 days ago
tech-leads-club