mde-readme
CommunityCreate READMEs with runnable MdExplorer examples.
Authorsalaroglio
Version1.0.0
Installs0
System Documentation
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.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: mde-readme Download link: https://github.com/salaroglio/MdExplorer/archive/main.zip#mde-readme Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 510,000+ vetted skills library on demand.