Skip to content

AI coding agent skills and llms.txt

A coding agent can learn Awesome Reveal from two sources: the agent skills of the packages, and a text version of these docs.

To start, copy a prompt for your agent:

  • The Get started page has a prompt that tells the agent to add the animations to your project.
  • Migrate from v4 has a prompt that tells the agent to migrate your code from react-awesome-reveal v4.

Each prompt tells the agent to install the package and to read the skill in the installed package. Thus the agent uses the skill of the version that you install.

Each package includes agent skills. A skill teaches a coding agent how to use the package:

  • adding-reveal-animations teaches the components, hooks, directives or functions of the package. @awesome-reveal/react, @awesome-reveal/vue, @awesome-reveal/astro and @awesome-reveal/core include it.
  • migrating-from-v4 teaches the changes from react-awesome-reveal v4. @awesome-reveal/react and react-awesome-reveal v5 include it. react-awesome-reveal v4 has no skills. See Migrate from v4.

The skills are in the skills directory of each package.

pnpm 12.11 or later links the skills of a direct dependency into your project. pnpm links nothing until you approve the package.

  1. Install the package. After the install, pnpm lists the packages with skills that wait for approval.

  2. Approve the package:

    Terminal window
    pnpm approve @awesome-reveal/react

pnpm writes the approval in the permissions setting of pnpm-workspace.yaml. The approval applies to all skills of the package, also in later versions:

pnpm-workspace.yaml
permissions:
"@awesome-reveal/react":
skills: true

pnpm links the skills into the agent skill directories that exist in the root of your workspace, such as .claude/skills. When an agent that pnpm recognizes runs pnpm, pnpm also creates the skill directory of that agent. pnpm recognizes an agent from the environment variables that the agent sets. To choose the directories, set skills.dirs. If pnpm finds no directory for an approved skill, the install fails.

The skills CLI gets the skills of a package from npmx.dev. Thus it works with each package manager, also before you install the package. The CLI needs Node.js 22.20 or later:

Terminal window
pnpm dlx skills add https://npmx.dev/@awesome-reveal/react

In the URL, use the name of your package: @awesome-reveal/react, @awesome-reveal/vue, @awesome-reveal/astro or @awesome-reveal/core. The CLI asks which skills to install, and for which agents.

npmx.dev gives the skills of the latest version of the package on npm. For react-awesome-reveal, that version is v4, so use the URL of @awesome-reveal/react to get migrating-from-v4. The installed skills do not change when you update the package. To update them, run the command again.

The docs site gives its content as text files for language models:

The files contain the current docs only. They do not contain the v4 docs.

Each docs page has a Markdown version. To get it, remove the last slash of the URL, and add .md. For example, the Markdown version of /guides/timing/ is /guides/timing.md. The Markdown version of the home page is /index.md.

The actions at the top of each page, except the home page, also give the Markdown version:

  • Copy page copies the Markdown to the clipboard.
  • View as Markdown opens the Markdown version.

On the current docs, the Ask Claude and Ask ChatGPT actions open a chat about the page.

The HTML of each page links to its Markdown version with <link rel="alternate" type="text/markdown">.