stig

Community

Generate clear C/C++ docs from code comments.

Authorbresilla
Version1.0.0
Installs0

System Documentation

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

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: stig
Download link: https://github.com/bresilla/dot/archive/main.zip#stig

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.