4 ms·
I think you'd benefit of having some more real-world-ish examples in the README, as someone who doesn't intuit what I'd want to use this for.
by broodbucket 2y ago
I think you'd benefit of having some more real-world-ish examples in the README, as someone who doesn't intuit what I'd want to use this for.
- iJohnDoe 2y agoAgreed. At least 5 examples of output shown being used against a standard markdown document.
- yshavit 2y agoThat's a great idea, thanks! I'll do that tomorrow or so. As a preview, two specific cases I've seen: 1) In PRs, some companies like to have semi-structured metadata, like a link to a related ticket under a heading "Ticket". In mdq, you could find that using `# Ticket | [](^https://issues.acme.com/ https://issues.acme.com/)` 2) Many projects ask people who submit bugs to check off whether they've searched for existing bugs. `- [x] I've looked in the bug tracker for existing bugs`