cogapp-markdown

Generate markdown documentation by executing embedded Python code with cogapp.

43|5|Updated Dec 29, 2025

Search Tags:#automation #developer tools #documentation #markdown #code generation #cogapp

Ready to run

npx skills add https://github.com/simonw/skills --skill cogapp-markdown

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: cogapp-markdown
Source: https://github.com/simonw/skills/tree/main/cogapp-markdown
Command: npx skills add https://github.com/simonw/skills --skill cogapp-markdown

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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.

Frequently Asked Questions about cogapp-markdown

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

FAQPage Schema

How do I auto-generate markdown documentation from code?▼

You can keep markdown documentation synchronized with code by embedding executable Python scripts directly within the markdown files, using cogapp to execute the scripts and regenerate the content automatically.

What is the best way to keep markdown documentation synchronized with code changes?▼

How do I embed dynamic CLI help output into markdown files?▼

To embed dynamic CLI help output into markdown files, you embed executable Python code within the markdown that triggers the CLI command, then run cogapp to execute the code and inject the output directly into the document.

Do I need Python to generate dynamic content in markdown using cogapp?▼

Yes, you need Python to generate dynamic content in markdown using cogapp, because the Skill relies on executing embedded Python scripts within the markdown files to produce the automated documentation output.

When should I use cogapp for markdown code generation instead of static documentation?▼

You should use cogapp for markdown code generation when your documentation requires dynamic content like generated tables or CLI outputs that must stay synchronized with frequent code changes to prevent outdated information.