What problem does it solve?
This skill enables transforming a codebase into a cohesive literate program: a narrative document that weaves prose, diagrams, and code while enabling code tangling back to the original sources.
Core Features & Use Cases
- Generates a .lit.md literate document from a codebase, serving as a single source of truth for both documentation and code.
- Tangles the document to produce the original source files and a .lit.map.json, enabling round-tripping.
- Weaves the literate program into PDFs via Pandoc (with Mermaid diagrams) and supports TikZ as an alternative.
- Includes reverse-sync: updates .lit.md automatically when source files change, then re-tangles.
- Supports a post-tool-use hook for automatic reverse-sync and a smooth workflow for onboarding and maintenance.
Quick Start
Install the skill and run the /literate-programming workflow on your codebase to generate and weave a .lit.md document.