Agent skill

Write API Reference

by videojs in videojs/video.js

Write generated Video.js API reference pages. An agent skill from videojs/video.js.

Custom licenceAuto-check passedDevelopment

Install Write API Reference

skills CLI
$ npx skills add videojs/video.js --skill write-api-reference -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install videojs/video.js write-api-reference --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/videojs/video.js.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/write-api-reference .claude/skills/write-api-reference && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
write-api-reference
GitHub stars
40k
Token cost
~804 tokens
SKILL.md length
381 words
Files
5 (incl. references)
Skills in repo
38
Repo updated
First seen
Licence
Custom licence

At a glance

Write generated Video.js API reference pages. An agent skill from videojs/video.js.

  • Works in 8 steps: Identify the export and read its… → Read… → Load only the needed reference → …
  • Builder compatibility
  • SKILL.md covers Workflow, Component pages, Utility pages and Validation, plus 1 more section
  • Calls pnpm

What it does

Write API Reference is an agent skill from videojs/video.js. Write generated Video.js API reference pages. Use for components, hooks, controllers, factories, builder compatibility, demos, or extracted JSDoc.

Its SKILL.md is about 800 tokens, which your agent loads only when the skill is triggered. The skill folder holds 5 other files, including reference files (for example `references/builder-conventions.md`, `references/demo-patterns.md` and `references/mdx-structure.md`).

It sits in Development, covering Technical documentation. The repository describes itself as: Video.js v10 - open source media player framework for HTML and React.

When your agent uses it

  • Builder compatibility
  • Extracted JSDoc

Example prompts

  • “/write-api-reference”

Workflow steps

8 steps, taken from the first numbered list in SKILL.md.

  1. Identify the export and read its implementation, public export path, tests, and any matching design record.
  2. Read site/scripts/api-docs-builder/src/tests/e2e.test.ts to confirm the builder contract involved in the change.
  3. Load only the needed reference
  4. Run pnpm -F site api-docs and inspect the corresponding file under site/src/content/generated-*-reference/.
  5. Fix missing metadata at the TypeScript/JSDoc source or in the builder. Do not hand-edit generated JSON.
  6. Create or update the page and the matching site/src/docs.config.ts entry when a page is required…
  7. Give extra exports a code heading or an ## Exports table row, or list them in apis when neither fits, then run pnpm -F site…
  8. Verify the page for every supported framework/style combination it targets.

What it can do on your machine

Read from SKILL.md and the folder at commit 50f59a2. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • pnpm

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use pnpm, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Write API Reference loads about 804 tokens when it runs, and up to ~9.3k if it reads all its reference files. Until then it costs about 42 tokens; SKILL.md has 381 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~42
When it runs · the whole SKILL.md, loaded when a task matches
~804
With references · SKILL.md plus every file in references/, read only if the agent opens them
~9.3k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

Its licence (Custom licence) doesn't allow us to republish the file, so here is its outline and opening line. It has 381 words (~804 tokens).

“Treat TypeScript source and the builder E2E test as the specification. Generated JSON is diagnostic output, not an editable source.”

— opening of SKILL.md by videojs, Custom licence
name
write-api-reference

Read the full SKILL.md on GitHub

Files

SKILL.md and 4 other files (references) in .agents/skills/write-api-reference of videojs/video.js.

  • SKILL.md
  • references/builder-conventions.md
  • references/demo-patterns.md
  • references/mdx-structure.md
  • references/util-conventions.md

Open the folder on GitHubat commit 50f59a2

Used in 1 other repository

We found 1 copy of this SKILL.md (exact, near-identical or edited) in other folders. This page covers the copy in videojs/video.js, which our catalogue first saw on October 7, 2026.

Compare with similar skills

Write API Reference next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Write API Reference compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Write API Reference this skillvideojs/video.js40k—~804Automated safety check: PassCustom licence
Diagram Designcathrynlavery/diagram-design44k1 repos~7.5kAutomated safety check: PassMIT
Simple Englishmoeru-ai/airi50k2 repos~4.6kAutomated safety check: PassMIT
Get API Docs with chubandrewyng/context-hub14k2 repos~775Automated safety check: PassMIT
Doc SyncJetBrains/ideavim10k2 repos~2.6kAutomated safety check: PassMIT
Mailspring App ScreenshotsFoundry376/Mailspring18k—~1.4kAutomated safety check: PassGPL-3.0

Similar skills

  • Diagram Design

    cathrynlavery/diagram-design

    Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.

    44k GitHub starsUsed in 1 repo~7.5k tokens
    DevelopmentAuto-check passed
  • Simple English

    moeru-ai/airi

    Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.

    50k GitHub starsUsed in 2 repos~4.6k tokens
    DevelopmentAuto-check passed
  • Get API Docs with chub

    andrewyng/context-hub

    Fetches current documentation for third-party APIs and SDKs with the chub CLI before the agent writes code against them, instead of relying on remembered API shapes.

    14k GitHub starsUsed in 2 repos~775 tokens
    DevelopmentAuto-check passed
  • Doc Sync

    JetBrains/ideavim

    Official

    Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.

    10k GitHub starsUsed in 2 repos~2.6k tokens
    DevelopmentAuto-check passed
  • Mailspring App Screenshots

    Foundry376/Mailspring

    Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.

    18k GitHub stars~1.4k tokensUpdated today
    DevelopmentAuto-check passed
  • Draw.io Diagram Studio

    Agents365-ai/drawio-skill

    Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.

    10k GitHub stars~2.4k tokensUpdated 5 days ago
    DevelopmentAuto-check: notes

More from videojs/video.js

All 38 skills in this repo
  • Commit PR

    videojs/video.js

    Commit, push, and create or update a Video.js pull request. An agent skill from videojs/video.js.

    40k GitHub stars~445 tokensUpdated today
    Auto-check passed
  • Maintain Tests

    videojs/video.js

    Gate and audit test value. An agent skill from videojs/video.js.

    40k GitHub stars~2.2k tokensUpdated today
    Auto-check passed
  • Write Docs

    videojs/video.js

    Write Video.js guides, concepts, READMEs, and JSDoc. An agent skill from videojs/video.js.

    40k GitHub stars~741 tokensUpdated today
    Auto-check passed
  • Translate or audit the values in a Video.js locale pack. An agent skill from videojs/video.js.

    40k GitHub stars~723 tokensUpdated today
    Auto-check passed
  • Change Spf Behavior

    videojs/video.js

    Change SPF playback-engine behaviors. An agent skill from videojs/video.js.

    40k GitHub stars~451 tokensUpdated today
    Auto-check passed
  • Create HTML Component

    videojs/video.js

    Create or change Video.js custom-element UI components. An agent skill from videojs/video.js.

    40k GitHub stars~729 tokensUpdated today
    Auto-check passed

Categories

Questions about Write API Reference

What does Write API Reference do?

Write generated Video.js API reference pages. An agent skill from videojs/video.js. js.js API reference pages.

When should I use Write API Reference?

Write API Reference fits situations like: builder compatibility; extracted JSDoc.

How do I install Write API Reference in Claude Code?

Run `npx skills add videojs/video.js --skill write-api-reference -a claude-code`. Or copy the skill folder (.agents/skills/write-api-reference in videojs/video.js) into .claude/skills/write-api-reference in your project. Claude Code loads it when a task matches its description.

How do I install Write API Reference in Codex?

Run `npx skills add videojs/video.js --skill write-api-reference -a codex`. Or copy the skill folder (.agents/skills/write-api-reference in videojs/video.js) into .agents/skills/write-api-reference in your project. Codex loads it when a task matches its description.

Can I use Write API Reference in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add videojs/video.js --skill write-api-reference -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/write-api-reference, .gemini/skills/write-api-reference, .github/skills/write-api-reference and .opencode/skills/write-api-reference in your project.

What does Write API Reference need to run?

Going by SKILL.md and its folder, Write API Reference needs the command-line tools its instructions call (pnpm).

Does Write API Reference access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Write API Reference safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Write API Reference use?

Write API Reference has a licence file (the repository's licence) that doesn't match a standard licence. Read it on GitHub before reusing the skill.

How many tokens does Write API Reference use?

About 804 tokens (SKILL.md is roughly 3.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 8.5k tokens, read only when the agent opens those files.

What are the alternatives to Write API Reference?

Skills that share tags, products or a category with Write API Reference: Diagram Design (cathrynlavery/diagram-design, 44k stars), Simple English (moeru-ai/airi, 50k stars), Get API Docs with chub (andrewyng/context-hub, 14k stars) and Doc Sync (JetBrains/ideavim, 10k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Write API Reference?

videojs (a GitHub organization) maintains it in videojs/video.js, which has 39,909 GitHub stars. The repository holds 38 skills in this directory. The repository was last updated on October 7, 2026.

Source: videojs/video.js on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.