skills.rest
DanSnow
DanSnowCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

md-to-runbook

Convert Markdown documentation into Atuin Runbook (.atrb) YAML format.

2|Updated Nov 24, 2024
Search Tags:#documentation#markdown#scripting#conversion#runbook#atuin
One-click install
npx skills add https://github.com/DanSnow/dotfiles --skill md-to-runbook
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: md-to-runbook
Source: https://github.com/DanSnow/dotfiles/tree/main/private_dot_claude/skills/md-to-runbook
Command: npx skills add https://github.com/DanSnow/dotfiles --skill md-to-runbook

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires mistune, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the conversion of standard Markdown documentation into the Atuin Runbook (.atrb) YAML format, making guides and documentation executable and interactive.

Core Features & Use Cases

  • Markdown to ATRB Conversion: Transforms headings, paragraphs, lists, code blocks, and tables into structured Atuin Runbook nodes.
  • Executable Code Blocks: Identifies and converts bash code blocks containing commands into interactive run nodes within the runbook.
  • Use Case: You have a detailed setup guide written in Markdown. Convert it into an Atuin Runbook so that users can execute the commands directly within the runbook interface, ensuring accurate and easy setup.

Quick Start

Use the md-to-runbook skill to convert the markdown file setup.md into an Atuin Runbook file named setup.atrb.

Frequently Asked Questions about md-to-runbook

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

FAQPage Schema
How do I convert Markdown documentation to an Atuin Runbook?▼

You can convert Markdown to an Atuin Runbook by parsing the Markdown syntax tree and generating .atrb YAML output. This process transforms standard documentation elements into structured, interactive runbook nodes.

What Markdown elements are supported when converting to an ATRB file?▼

Supported Markdown elements for ATRB conversion include headings, paragraphs, lists, tables, and code blocks. The parser specifically distinguishes between executable bash commands and display-only code blocks.

Does converting Markdown to an interactive runbook require Python?▼

Converting Markdown to an interactive runbook requires Python and the mistune library. These dependencies parse the Markdown abstract syntax tree and generate the YAML output required for Atuin Runbook nodes.

How are executable code blocks handled during Markdown to YAML conversion?▼

During Markdown to YAML conversion, executable bash code blocks are identified and transformed into interactive run nodes. This mechanism allows commands within the documentation to be executed directly in the runbook interface.

What is the best way to make a Markdown setup guide executable?▼

The best way to make a Markdown setup guide executable is to convert it into an Atuin Runbook. This approach translates bash code blocks into interactive run nodes, enabling users to execute setup commands directly.

Related Skills

Explore More Software Engineering Skills→
mcclowesmcclowes

commonmark

Parse Markdown into an AST and render it to HTML per CommonMark.

Community
Intermediate
diegopetruccidiegopetrucci
21

harness-setup

Install, configure, and audit The Last Harness isolated Pi package with Node.js and Bash scripts.

Community
Advanced
zhizhunbaozhizhunbao

dev-pptx_to_md

Convert PowerPoint PPTX presentations into Markdown documents.

Community
Basic
zachmayerzachmayer
2

pdf-to-markdown

Convert PDF documents into structured markdown text using the marker library.

Community
Intermediate