sample-with-references
Uses on-demand loading of reference files to keep main documentation concise and efficient.
Install
mkdir -p .claude/skills/sample-with-references && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/5008" && unzip -o skill.zip -d .claude/skills/sample-with-references && rm skill.zipInstalls to .claude/skills/sample-with-references
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
Demonstrates progressive disclosure by linking to reference files. Use this pattern when your skill has detailed content that should load on-demand.Key capabilities
- →Implement on-demand documentation loading
- →Modularize large API references
- →Structure documentation hierarchy
- →Optimize AI context window usage
- →Link related markdown files
How it works
Separates overview content from deep-dive references, loading supplementary files into the AI context only upon navigation or explicit request.
Inputs & outputs
When to use sample-with-references
- →Modularize large API documentation
- →Implement on-demand loading for tutorials
- →Structure complex project reference files
About this skill
Sample Skill with References
This skill demonstrates progressive disclosure - keeping the main SKILL.md concise while linking to detailed reference files that Claude loads only when needed.
When to Use This Pattern
Use reference files when you have:
- Detailed API documentation
- Multiple workflows or domains
- Large code examples
- Configuration references
Quick Reference
For detailed patterns and examples, see REFERENCE.md.
How It Works
- Startup: Only
nameanddescriptionload into context - Triggered: Claude reads this SKILL.md (~100-200 tokens)
- On-demand: Claude reads REFERENCE.md only if needed
This keeps token usage low while providing comprehensive documentation.
File Organization Tips
your-skill/
├── SKILL.md # Overview and navigation (keep under 500 lines)
├── REFERENCE.md # Detailed reference (loaded on-demand)
├── WORKFLOWS.md # Step-by-step guides (loaded on-demand)
└── EXAMPLES.md # Code examples (loaded on-demand)
Best Practices
- Keep references one level deep (don't chain REFERENCE.md → ANOTHER.md)
- Use descriptive filenames (not
doc1.md,doc2.md) - Add a table of contents to files over 100 lines
- Link with relative paths:
[REFERENCE.md](REFERENCE.md)
When not to use it
- →Simple, short documentation sets, Projects requiring monolithic file structures
Limitations
- →Limited to one-level deep referencing
- →Requires manual file structure maintenance
How it compares
Reduces token consumption by deferring the loading of detailed background information.
Compared to similar skills
sample-with-references side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| sample-with-references (this skill) | 1 | 7mo | No flags | Beginner |
| markdown-to-html | 16 | 6mo | Review | Beginner |
| claude-md-enhancer | 1 | 9mo | Review | Beginner |
| deepinit | 1 | 5mo | Review | Beginner |
Try saying
Example prompts that trigger this skill in your AI assistant.
More by svelte-society
View all by svelte-society →You might also like
markdown-to-html
github
Convert Markdown files to HTML similar to `marked.js`, `pandoc`, `gomarkdown/markdown`, or similar tools; or writing custom script to convert markdown to html and/or working on web template systems like `jekyll/jekyll`, `gohugoio/hugo`, or similar web templating systems that utilize markdown documents, converting them to html. Use when asked to "convert markdown to html", "transform md to html", "render markdown", "generate html from markdown", or when working with .md files and/or web a templating system that converts markdown to HTML output. Supports CLI and Node.js workflows with GFM, CommonMark, and standard Markdown flavors.
claude-md-enhancer
alirezarezvani
Analyzes, generates, and enhances CLAUDE.md files for any project type using best practices, modular architecture support, and tech stack customization. Use when setting up new projects, improving existing CLAUDE.md files, or establishing AI-assisted development standards.
deepinit
Yeachan-Heo
Deep codebase initialization with hierarchical AGENTS.md documentation
ability-generator
lofcz
This skill generates markdown skill templates to be later used.
website-maintainer
yamadashy
Use this skill when working on the Repomix documentation website in `website/` directory, including VitePress configuration, multi-language content, or translation workflows.
update-version
ZingerLittleBee
Update Dockerman version and changelog. Use when releasing a new version with changelog content in markdown format.