MDQ: jq for Markdown

Query and filter Markdown documents with ease - just like jq does for JSON

Code Coverage Build Status

Installation

Via Cargo

cargo install --git https://github.com/yshavit/mdq

Direct Download

Download Latest Release

Basic Usage

Filter Sections

cat example.md | mdq '# usage'

Find Tasks

mdq '- [ ]'

Chain Filters

cat example.md | mdq '# usage | -'

Real-World Examples

Check Issue Templates

if echo "$ISSUE_TEXT" | mdq -q '- [x] I have searched for existing issues' ; then

Verify that users have checked for duplicate issues

Extract Tickets

TICKETURL="$(echo "$PRTEXT" | mdq --output json '# Ticket')"

Parse ticket references from pull requests