stig

Generate Markdown, mdbook, JSON, or HTML docs from Doxygen-style C/C++ comments.

1|Updated Aug 14, 2024
One-click install
npx skills add https://github.com/bresilla/dot --skill stig
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: stig
Source: https://github.com/bresilla/dot/tree/main/.config/opencode/skill/stig
Command: npx skills add https://github.com/bresilla/dot --skill stig

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Stig automates the generation of documentation from C/C++ sources by converting Doxygen-style comments into markdown, mdbook, JSON, or HTML formats, improving consistency and readability for API references.

Core Features & Use Cases

  • Parses Doxygen-style comments using fast parsing to produce multiple outputs formats (markdown, mdbook, JSON, HTML).
  • Generates cross-referenced documentation with links between types, functions, and pages, enabling easy navigation and CI/CD integration.
  • Supports configurable workflows via stig.toml for output customization, section naming, and external docs linking; ideal for maintainers who need up-to-date docs in repo dashboards or published docs.

Quick Start

Install stig and run a simple generate against your sources, for example: stig generate -o docs -f mdbook include/*.hpp

Frequently Asked Questions about stig

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

FAQPage Schema
How do I generate markdown documentation from Doxygen comments in C++ code?

You can generate markdown documentation from Doxygen comments in C++ code by parsing the source files and rendering the comments into multiple output formats. This process converts existing Doxygen-style annotations into consumable markdown, mdbook, JSON, or HTML API references.

Can I integrate C++ API documentation generation into my CI/CD pipeline?

Yes, you can integrate C++ API documentation generation into CI/CD pipelines by running an automated generation step against your source files. This produces cross-referenced markdown or HTML docs that keep published references up-to-date during continuous integration.

How do I create cross-referenced links between C++ types and functions in mdbook?

Creating cross-referenced links in mdbook involves parsing C++ source files to map relationships between types, functions, and pages. The documentation generator automatically builds navigation links between these elements, enabling easy browsing of the API reference.

What is the best way to customize C++ documentation sections and external links?

The best way to customize C++ documentation sections and external links is by using a configuration file. Configuring the generation process via a TOML file allows you to tailor output formats, section naming, and external documentation linking to fit your project requirements.

Do I need Doxygen installed to generate mdbook from C++ source comments?

No, you do not need Doxygen installed to generate mdbook from C++ source comments. The generation tool directly parses Doxygen-style comments using its own fast parsing mechanism and supports Doxygen tag parsing to produce the documentation output.