cogapp-markdown

What problem does it solve?

This Skill automates the generation of markdown documentation by embedding Python code directly within markdown files, ensuring documentation stays synchronized with the underlying code.

Core Features & Use Cases

• Dynamic Documentation: Embed Python code to generate content like CLI help output, tables, or code blocks directly into markdown files.
• Code-Doc Sync: Automatically update documentation sections when code changes, preventing outdated information.
• Use Case: Keep your project's README file updated with the latest --help output from your command-line interface by embedding the output directly using cogapp.

Quick Start

Use cogapp to regenerate all markdown documentation files in the docs directory.