3d-in-readme SKILL.md skillA
This file is byte-identical to the first copy the registry indexed. Same content hash, so the same checks give both the same grade.
3d-in-readme from nirholas/three.ws is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add nirholas/three.ws/3d-in-readme@git:20260713.8b8c13ePins git:20260713.8b8c13e in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- nirholas/three.ws
- Path
packages/readme-3d/skills/3d-in-readme/SKILL.md- Versions recorded
- 1
- Latest version
- git:20260713.8b8c13e, committed Jul 13, 2026
- Size
- 2,793 bytes
- Repository stars
- 269
- License
- Apache-2.0
Embed an interactive 3D model in a GitHub README, issue, PR, or any markdown file. Use when the user wants to add, embed, or show a 3D model, avatar, mesh, STL, GLB, or 3D print in markdown or a README - "add a 3D model to my README", "embed this GLB", "show the part in the issue". Converts GLB/glTF/OBJ/STL to the ASCII STL block GitHub renders natively, simplified to fit GitHub's 512 KB markdown limit.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# Put a 3D model in GitHub markdown
GitHub renders ASCII STL inside a ` ```stl ` fenced code block as an interactive 3D viewer - in READMEs, issues, PRs, discussions, and gists. The `readme-3d` CLI converts real model files into those blocks.
## Workflow
1. **Get the model file.** Accept `.glb`, `.gltf`, `.obj`, `.stl`, or `.ast`. If the user has no model but describes one, generate it first (step 2); otherwise skip to step 3.
2. **(Optional) Generate from text.** POST to the free three.ws Forge API - no key or account:
```bash
curl -s -X POST https://three.ws/api/v1/ai/text-to-3d \
-H 'content-type: application/json' \
-d '{"prompt": "<single object, shape-first description>"}'
```
If `data.status` is `"done"`, download `data.glb_url`. If `"pending"`, poll `GET https://three.ws/api/forge?job=<data.job>` every 5 s until `status` is `"done"` (allow ~2 min). Shape-first prompts work best: silhouette survives the monochrome STL render, textures do not.
3. **Convert with a byte budget.** Check the target markdown file's current size first, leave headroom under GitHub's 512 KB render limit, and never spend more than ~60% of what remains:
```bash
…Read the whole file at its exact version.
How to install
mdr add nirholas/three.ws/3d-in-readme@sha256:3e6da7569649fcc2The line at the top of this page pins the label git:20260713.8b8c13e, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_qnzxhqexchy2iof4)
4 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Jul 13, 2026.
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (2793 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
nirholas/three.ws · 269 stars · license Apache-2.0 · pushed 2026-11-06 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_qnzxhqexchy2iof4 GET https://markdownregistry.com/api/v1/resolve?ref=nirholas/three.ws/3d-in-readme GET https://markdownregistry.com/api/v1/blob/3e6da7569649fcc2a8fbf9d1de5b1ca716880a5a569240bccf7c68fdb7547fb2
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.
More from nirholas/three.ws
Every file in nirholas/three.ws