Convert source code files into markdown documents using a comment prefix.
npx skills add https://github.com/praetoriansentry/litdown --skill litdown
Please help me install this Agent Skill. Skill: litdown Source: https://github.com/praetoriansentry/litdown/tree/main/litdown-skill Command: npx skills add https://github.com/praetoriansentry/litdown --skill litdown
This Skill enables the creation of literate programming source files, where code is accompanied by markdown documentation, facilitating a seamless integration of code and documentation.
Use the litdown skill to convert the 'example.sh' script into a markdown document.
High-intent search queries and answers about installing and using this skill.
To convert source code into markdown documentation, you execute the litdown tool on your source file. It extracts specially prefixed comments as prose and wraps the remaining code in fenced markdown code blocks.
Literate programming integrates code and documentation in the same file. This Skill enables it by converting specially prefixed comments into markdown text, allowing you to write explanations directly alongside your source code.
Yes, you can use a custom comment prefix to support different programming languages. This allows the markdown generation process to distinguish prose comments from actual code regardless of your language's syntax.
Yes, this markdown generation approach works with any programming language. By specifying a customizable comment style prefix, the tool can accurately separate documentation from code across various language formats.
The best way to generate markdown code blocks from an existing codebase is to run a literate programming converter. It parses your source files, extracts prefixed comments as text, and formats the code with syntax highlighting.
A limitation of using a single comment prefix for code documentation is that all intended prose must strictly use that specific prefix. Any standard comments in the code will be treated as regular code and wrapped in fenced blocks.
chipoto69Capture timestamped notes and voice memos into a PARA-structured Vaultage inbox.
mcclowesParse Markdown into an AST and render it to HTML per CommonMark.
BirdywenConvert, trim, merge, extract, and compress audio and video files with FFmpeg.
orangehrmAnnotate OrangeHRM REST API endpoints with OpenAPI v3 annotations.
