mde-readme

Generate README sections with runnable CLI examples for MdExplorer.

5|Updated Mar 21, 2021
One-click install
npx skills add https://github.com/salaroglio/MdExplorer --skill mde-readme
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mde-readme
Source: https://github.com/salaroglio/MdExplorer/tree/main/MdExplorer/skills/mde-readme
Command: npx skills add https://github.com/salaroglio/MdExplorer --skill mde-readme

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documents READMEs with runnable script examples MdExplorer can execute, enabling interactive demonstrations of CLI commands in project READMEs.

Core Features & Use Cases

  • Generate README sections containing runnable blocks that MdExplorer can render and execute.
  • Enforce a YAML frontmatter with name and description and a structured runnable block format for parameter documentation.
  • Ensure commands run from the project root and support multiple shells and path pickers for consistent cross-platform behavior.

Quick Start

Create or edit a README using the runnable block convention and let MdExplorer render and run the examples.

Frequently Asked Questions about mde-readme

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

FAQPage Schema
How do I add runnable command-line examples to a project README?

Runnable README examples require YAML frontmatter containing name and description, followed by an mde block for distribution metadata and runnable blocks using @param headers for parameter documentation.

Can I document CLI tool parameters using runnable blocks in markdown?

Yes, you can document CLI tool parameters using runnable blocks in markdown by enforcing a structured format with @param headers that MdExplorer parses to execute commands interactively.

Does MdExplorer support cross-platform shell commands in README documentation?

MdExplorer supports cross-platform shell commands in README documentation by enforcing root-relative command execution and supporting multiple shells and path pickers for consistent behavior across different environments.

What is the best way to create interactive documentation for CLI tools?

The best way to create interactive documentation for CLI tools is generating README sections with structured runnable blocks that MdExplorer renders and executes, allowing users to run script examples directly from the documentation.

Why do my runnable README examples require YAML frontmatter?

Runnable README examples require YAML frontmatter containing name and description fields to provide essential metadata that MdExplorer uses to identify, render, and execute the interactive command-line blocks properly.