skills.rest
TypeThe0ry
TypeThe0ryCOMMUNITY
Explore all skills by this author →
GitHub

qt-qml-docs

Generates structured Markdown reference documentation from QML source files.

1|Updated Jul 12, 2026
Search Tags:#documentation#markdown#Qt#generate#reference docs#qml#qt quick
One-click install
npx skills add https://github.com/TypeThe0ry/Multi-Detect --skill qt-qml-docs-typethe0ry
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: qt-qml-docs
Source: https://github.com/TypeThe0ry/Multi-Detect/tree/main/ground-control/MultiDetectGCS/tools/skills/qt-qml-docs
Command: npx skills add https://github.com/TypeThe0ry/Multi-Detect --skill qt-qml-docs-typethe0ry

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing and maintaining reference documentation for QML components is repetitive and often skipped, leaving developers without a clear picture of properties, signals, methods, and inter-component interactions in a Qt Quick project. ## Core Features & Use Cases - Structured Component Docs: Generates one Markdown file per QML component covering overview, dependencies, hierarchy, properties, signals, methods, and interactions. - Project-Wide Documentation: Walks entire folders, reads CMakeLists.txt, qmldir, and C++ headers for context, and creates an index.md linking all documented components. - Existing-Doc Awareness: Checks for previously generated docs and asks whether to update, skip, regenerate, or cancel before overwriting. - Use Case: Point the skill at a Qt Quick application's QML directory to produce a complete doc/ folder with per-component reference pages and a linked index for onboarding new developers. ## Quick Start Ask the assistant to document the QML files in your project folder and generate Markdown reference docs for each component.

Frequently Asked Questions about qt-qml-docs

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

FAQPage Schema
How do I generate documentation for QML components?▼

Provide one or more .qml files or a project folder, and the skill reads the sources plus related CMakeLists.txt, qmldir, and C++ headers to produce structured Markdown reference docs. Each component gets its own .md file in a doc/ subdirectory.

What sections does QML component documentation include?▼

Each generated document covers component overview, project structure and dependencies, component hierarchy, a properties table, signals, methods, inter-component interactions, and a usage example for reusable components. Empty sections are omitted.

Can I document an entire Qt Quick project folder at once?▼

Yes, the skill walks the directory tree, finds all .qml files, and generates one Markdown file per component. When documenting two or more components, it also creates a doc/index.md linking every component with a one-line description.

Does the skill overwrite existing QML documentation?▼

Before reading sources, it checks the doc/ directory for existing files and asks whether to update them, skip documented files, regenerate everything, or cancel. Nothing is overwritten without your explicit choice.

When should I use QDoc instead of this Markdown documentation approach?▼

Use QDoc when you need Qt's official documentation format with its own markup and tooling. This skill explicitly does not produce QDoc output; it generates standalone developer-facing Markdown reference docs only.

Related Skills

Explore More Software Engineering Skills→
rghamilton3rghamilton3

qt-qml-component-generator

Generate QML components with property bindings and C++ backend integration.

Community
Intermediate
lailtonjuniorlailtonjunior

Documentation

Generate and update Markdown and HTML documentation from code, schemas, and design notes.

Community
Intermediate
dotBeepsdotBeeps

qtqml

Define Qt QML conventions for C++ type exposure and module organization.

Community
Advanced
qtqt
19

skill-vale-qdoc-lint

Lint QDoc, QML, and C++ doc-comments with a patched Vale binary.

Official
Intermediate