playbooks

home / skills / upamune / radicaster / htmx

htmx skill

/.claude/skills/htmx

This skill helps you access HTMX documentation quickly, enabling you to search, read, and cite sources from docs/ with fetched timestamps.

npx playbooks add skill upamune/radicaster --skill htmx

Review the files below or copy the command above to add this skill to your agents.

Files (4)
SKILL.md
721 B
---
name: htmx
description: HTMX documentation assistant
---

# HTMX Skill

This skill provides access to HTMX documentation.

## Documentation

All documentation files are in the `docs/` directory as Markdown files.

## Search Tool

```bash
python scripts/search_docs.py "<query>"
```

Options:
- `--json` - Output as JSON
- `--max-results N` - Limit results (default: 10)

## Usage

1. Search or read files in `docs/` for relevant information
2. Each file has frontmatter with `source_url` and `fetched_at`
3. Always cite the source URL in responses
4. Note the fetch date - documentation may have changed

## Response Format

```
[Answer based on documentation]

**Source:** [source_url]
**Fetched:** [fetched_at]
```

Overview

This skill is an HTMX documentation assistant that helps you find and summarize HTMX concepts, attributes, and examples from the bundled documentation. It provides quick, sourced answers and points to the exact doc pages so you can verify details. Use it to speed up implementation and learn recommended patterns.

How this skill works

The skill searches and reads Markdown files stored in the documentation directory to locate relevant sections, examples, and frontmatter metadata. It can run a fast text search or open specific files, extract source_url and fetched_at metadata, and return concise answers with the original source cited. It also supports JSON-formatted search output for programmatic workflows.

When to use it

  • Learning HTMX attributes, events, and request lifecycle
  • Finding example snippets for hx-get, hx-post, hx-boost, etc.
  • Confirming the recommended patterns and best practices from the docs
  • Troubleshooting unexpected client-server behavior with HTMX
  • Preparing documentation-based answers with exact source citations

Best practices

  • Search before answering to cite the specific documentation page and fetched date
  • Prefer concrete snippets from the docs when suggesting code changes
  • Highlight the source_url and fetched_at so users can verify freshness
  • Limit recommendations to documented features and clearly label experimental or custom patterns
  • Use the search tool with --max-results to narrow large results sets

Example use cases

  • Show the correct hx-boost usage and a minimal example with link to the doc page
  • Compare hx-trigger event options and cite the source that lists them
  • Provide a short troubleshooting checklist for failed hx-requests with doc references
  • Extract an example of server response headers that HTMX expects and link to the original page
  • Return JSON search output for integration into CI or editor tooling

FAQ

How do you ensure answers stay accurate?

I locate the relevant Markdown doc, extract its frontmatter (source_url and fetched_at), and include both so you can verify the original content and when it was fetched.

Can I get search results as machine-readable data?

Yes. Use the search tool with the --json option to receive results in JSON for automation or editor plugins.