idx.md
Purpose
- •Markdown registry for AI agent libraries and resources.
- •Agents can browse to learn everything they could use, then fetch the exact markdown.
Index locations
Index entry format
- •Each entry is a HEAD frontmatter block followed by a topic line.
- •Topic line format:
|/data/{topic}| - •The index may start with a short HTML comment preamble; entries begin at the first
---frontmatter block.
...frontmatter...
|/data/openclaw|
How to fetch
- •Read
https://idx.md/index.md. - •Choose
{topic}from the|/data/{topic}|line. - •HEAD metadata:
https://idx.md/{topic}(or/data/{topic}/HEAD.md) - •BODY content:
https://idx.md/{topic}/BODY.md - •After download, compute SHA-256 on the raw BODY bytes and compare to
content_sha256in HEAD frontmatter. - •Use
retrieved_atto decide whether a cached BODY needs refresh.
URL map
- •
/,/skill.md,/SKILL.md-> this document - •
/index.md,/data/index.md-> index listing - •
/category/index.md-> category index listing - •
/category/{category}/index.md-> category topic listing - •
/{topic}->/data/{topic}/HEAD.md - •
/{topic}/HEAD.md-> HEAD metadata - •
/{topic}/BODY.md-> BODY content
Constraints
- •
.mdonly;.mdxrejected by filename.
Integrity / Hash
- •
content_sha256lives in the HEAD frontmatter. - •
content_sha256is the SHA-256 of the exact BODY bytes (no normalization). - •Format: lowercase hex string.
- •Verify by hashing the downloaded BODY.md bytes and comparing to
content_sha256. - •If the hash differs, re-download BODY.md.
Example flow
- •Read
/index.md-> pickopenclaw-> fetch/openclaw/HEAD.md-> fetch/openclaw/BODY.md.
Contribute
If you find a high-quality markdown resource that agents should know about, please open a PR to add it. Repo: https://github.com/Keith-CY/idx.md
What to add
- •Add new sources to
sources/general.yml. - •Use a direct markdown URL (
.md) and preferraw.githubusercontent.comfor GitHub content. - •
.mdxfiles are rejected. - •Choose a
typeandslugthat match^[a-z0-9][a-z0-9-]*$. - •Avoid editing auto-generated registries (
sources/openclaw.yml,sources/openai.yml, etc.) ordata/outputs directly.
Minimal entry example
yaml
- type: skills
slug: acme-awesome-skill
source_url: https://raw.githubusercontent.com/acme/awesome-skill/main/SKILL.md
title: Awesome Skill (optional)
summary: One-line summary (optional)
tags:
- skills
license: MIT (optional)
upstream_ref: https://github.com/acme/awesome-skill/blob/main/SKILL.md (optional)
How to submit
- •Fork the repo: https://github.com/Keith-CY/idx.md
- •Add your entry to
sources/general.yml. - •Open a PR with a short note on why the source is valuable for agents.
- •If you can run the build, include generated
data/updates; otherwise the maintainer will handle it.
Thanks for helping keep idx.md useful and current.