buildHtml
baseUrl https://mdq.scroll.pub
metaTags
editButton /edit.html
title mdq: jq for Markdown
style.css
header
class hero
div
class hero-content
div
class badges
a
href https://github.com/yshavit/mdq/actions/workflows/coverage.yml
img
alt Code Coverage
src https://img.shields.io/endpoint?url=https%3A%2F%2Fgist.githubusercontent.com%2Fyshavit%2F53901a0115b596e015a891c41fb0f256%2Fraw%2Fmdq-coverage.json
a
href https://github.com/yshavit/mdq/actions/workflows/rust.yml
img
alt Build status
src https://github.com/yshavit/mdq/actions/workflows/rust.yml/badge.svg
a
href https://github.com/search?q=repo%3Ayshavit%2Fmdq+NOT+path%3A.github%2Fworkflows%2Fcoverage.yml+NOT+path%3AREADME.md+todo&type=code
img
alt Pending TODOs
src https://img.shields.io/endpoint?url=https%3A%2F%2Fgist.githubusercontent.com%2Fyshavit%2Fe7a9e9e72651da0d7d2b1fbbe56237d0%2Fraw%2Fmdq-todos.json
a
href https://github.com/search?q=repo%3Ayshavit%2Fmdq+%28%28path%3A%2F%5C.rs%24%2F+%22%23%5Bignore%5D%22%29+OR+%28path%3Atests%2Fmd_cases+%2F%5Eignore%2F%29%29&type=code
img
alt Ignored tests
src https://img.shields.io/endpoint?url=https%3A%2F%2Fgist.githubusercontent.com%2Fyshavit%2F782a8dc5f77d2cf4b1c774da72636f00%2Fraw%2Fmdq-ignoreds.json
h1 mdq
p class tagline jq for Markdown
main
section
class intro
h2 What is mdq?
p mdq lets you query Markdown documents like jq queries JSON. Extract sections, lists, tables and more with intuitive syntax.
pre
code
| cat example.md | mdq '# usage | -'
section
class features
div
class feature-grid
div
class feature-card
h3 📖 Semantic Queries
p Use Markdown-like syntax to match document structure
div
class feature-card
h3 🔗 Piped Filters
p Chain filters with | operator for precise targeting
div
class feature-card
h3 🛠️ Rich Output
p Get results as plain text, JSON, or formatted Markdown
section
class installation
h2 Installation
div
class code-group
pre
code lang shell
| cargo install --git https://github.com/yshavit/mdq
div
class install-options
p Or download binaries from
a
href https://github.com/yshavit/mdq/releases/latest
latest release
section
class examples
h2 Examples
div
class example-grid
div
class example-card
h3 Extract Checklists
pre
code lang shell
| mdq '- [ ]' issues.md
p Find all incomplete tasks
div
class example-card
h3 Parse Tables
pre
code lang shell
| mdq ':-: * :-: 2024-01-15' schedule.md
p Filter table rows by date
div
class example-card
h3 Find Links
pre
code lang shell
| mdq '[Ticket](^https://tickets/.*)' pr.md | jq .url
p Extract ticket URLs as JSON
footer
class footer
div
class footer-content
div
class footer-links
a
href https://github.com/yshavit/mdq/wiki
Documentation
a
href https://github.com/yshavit/mdq
GitHub
a
href https://github.com/yshavit/mdq/issues
Issues
p Licensed under Apache 2.0 or MIT
script.js