DEV Community

Cover image for ๐Ÿš€ Meet QMD : Quick Markdown
aj1thkr1sh
aj1thkr1sh

Posted on

๐Ÿš€ Meet QMD : Quick Markdown

Hey Developers! ๐Ÿ‘‹

TL;DR: Single-character syntax = significant fewer tokens = cheaper AI costs ๐ŸŽฏ


What if I told you there's a way to make your Markdown few percentage more efficient for LLMs while keeping it just as readable for humans?

Sounds too good to be true? Well, Quick Markdown (QMD) is here to change the game! ๐ŸŽฎ

๐Ÿค” What is Quick Markdown?

Quick Markdown (QMD) is a lightweight markup language that maintains Markdown's readability while significantly reducing storage requirements and token consumption.

Enter: QMD ๐ŸŽฏ

๐Ÿง  Built for LLMs(in addition)
๐Ÿ’พ Reduces token & storage usage
๐Ÿ“ Compact, clean, and context-aware
๐Ÿ” Still plays nicely with traditional Markdown!

Itโ€™s like Markdown, but on a diet ๐Ÿ’ช๐Ÿƒ

๐Ÿ’ญ Show us example, man

Yes, yes, here are examples by comparison

Traditional:    ## Heading Two        (3 tokens)
QMD:            >Heading Two          (1 token) ๐ŸŽ‰

Traditional:    **bold text**         (4 tokens)  
QMD:            *bold text*           (2 tokens) โšก

Traditional:    - [x] Done task       (6 tokens)
QMD:            + Done task           (2 tokens) ๐Ÿ€ 
Enter fullscreen mode Exit fullscreen mode

๐Ÿ’ต Real impact

Comparison: Traditional vs QMD

Traditional Markdown (231 bytes):

## Shopping List

**Important** items to buy:

- Milk
- Bread
  - Whole wheat
  - Sourdough
- ~~Eggs~~ Already have

### Tasks
- [x] Buy groceries
- [ ] Call store
- [~] Check prices

### Notes

Check https://store.com for *deals*.
Enter fullscreen mode Exit fullscreen mode

QMD Version (217 bytes, approximatelyโ€ฏ6.1โ€ฏ% reduction):

>Shopping List

*Important* items to buy:

โ€ข Milk
โ€ข Bread
  โ€ข Whole wheat
  โ€ข Sourdough
โ€ข ~Eggs~ Already have

-Tasks
+ Buy groceries
. Call store
* Check prices

-Notes

Check https://store.com for /deals/.
Enter fullscreen mode Exit fullscreen mode

For larger files, the compression ratio between QMD and MD should be significantly better

๐Ÿš€ Ready to Start?

Check out the GitHub repo and start using QMD today! Your LLM bills will thank you! ๐Ÿ’ฐ

GitHub : https://github.com/ajithraghavan/qmd

The future of documentation is Quick, Quality, and ready for a Quantum-leap! โšก

โญ Star it on GitHub, clone it, try it out and tell us what you think!

Built something cool with QMD

๐Ÿ’ฌ Drop it in the comments!

Top comments (0)