Agent skill

Document Component

by inkline in inkline/inkline

Phase 5 of building an Inkline component — finalize docs and the release.

No licenceAuto-check: notesFrontend & Design

Install Document Component

skills CLI
$ npx skills add inkline/inkline --skill document-component -a claude-code

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

GitHub CLI
$ gh skill install inkline/inkline document-component --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/inkline/inkline.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/document-component .claude/skills/document-component && 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
document-component
GitHub stars
1.5k
Token cost
~883 tokens
SKILL.md length
402 words
Files
1
Skills in repo
23
Repo updated
First seen
Licence
None found

At a glance

Phase 5 of building an Inkline component — finalize docs and the release.

  • Works in 5 steps: TSDoc completeness pass → Changeset → Freshness → …
  • Wrapping up a component for release
  • SKILL.md covers Read first, Steps and Exit criteria
  • Calls pnpm

What it does

Document Component is an agent skill from inkline/inkline. Phase 5 of building an Inkline component — finalize docs and the release. Complete TSDoc on the prop interfaces, add a changeset for the affected framework packages, confirm exports/freshness, and stage the future docs-site page (the docs website is not built yet — TBD). Use when wrapping up a component for release.

Its SKILL.md is about 880 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Frontend & Design, covering Static sites and blogs. The repository describes itself as: Inkline is the intuitive UI Components library that gives you a developer-friendly foundation for building high-quality, accessible, and customizable Vue.js 3 Design Systems.

When your agent uses it

  • Wrapping up a component for release
  • Tasks that involve Static sites and blogs

Example prompts

  • “/document-component”

Requirements

  • Pre-approved tools (allowed-tools): Read, Write, Edit, Bash

Workflow steps

5 steps, taken from the step headings in SKILL.md.

  1. TSDoc completeness pass
  2. Changeset
  3. Freshness
  4. Docs website — TBD (stage, don't ship)
  5. Final verify

What it can do on your machine

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

  • Tool permissions

    Pre-approves these tools, so the agent can use them without asking each time:

    • Read
    • Write
    • Edit
    • Bash

    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

Document Component loads about 883 tokens when it runs. Until then it costs about 84 tokens; SKILL.md has 402 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~84
When it runs · the whole SKILL.md, loaded when a task matches
~883

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: notes

The automated check noted patterns worth knowing about, such as sudo or a known installer.

  • NotePre-approves every shell command (allowed-tools: Bash)SKILL.md
    allowed-tools: Read, Write, Edit, Bash

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

Without a licence we can't republish the file, so here is its outline and opening line. It has 402 words (~883 tokens).

“The public docs website does not exist yet — so the "document" phase today means: make the API self-documenting (TSDoc), prepare the release (changeset), keep the repo's own docs honest, and stage the future docs-site content without shipping anything speculative.”

— opening of SKILL.md by inkline
name
document-component
allowed-tools
Read, Write, Edit, Bash
triggers
document a component, finalize a component, add a changeset for the component

Read the full SKILL.md on GitHub

Files

Just SKILL.md in .claude/skills/document-component of inkline/inkline.

Open the folder on GitHubat commit f4da55a

Compare with similar skills

Document Component 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.

Document Component compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Document Component this skillinkline/inkline1.5k—~883Automated safety check: NotesNone
Tabler Astro Dev Servertabler/tabler42k—~1.2kAutomated safety check: PassMIT
Create Docsvictorgarciaesgi/nuxt-typed-router4132 repos~2.8kAutomated safety check: PassMIT
Tabler Astro Component Scriptstabler/tabler42k—~2.1kAutomated safety check: PassMIT
Paperclip Pagepaperclipai/paperclip99k—~1kAutomated safety check: PassMIT
Kill AI Slopyetone/kill-ai-slop1.3k—~1.4kAutomated safety check: PassApache-2.0

Similar skills

  • Starts the right Tabler dev server, keeps it from clashing with builds and verifies changes in the browser before a page or component is handed back.

    42k GitHub stars~1.2k tokensUpdated yesterday
    Frontend & DesignAuto-check passed
  • Create Docs

    victorgarciaesgi/nuxt-typed-router

    Create complete documentation sites for projects. An agent skill from victorgarciaesgi/nuxt-typed-router.

    413 GitHub starsUsed in 2 repos~2.8k tokens
    Frontend & DesignAuto-check passed
  • Rules for adding or fixing client-side scripts in Tabler's Astro components so the copied preview HTML stays readable, self-contained and runs in the right order.

    42k GitHub stars~2.1k tokensUpdated yesterday
    Frontend & DesignAuto-check passed
  • Paperclip Page

    paperclipai/paperclip

    Publish static HTML pages and asset folders to the Paperclip S3/CloudFront page host.

    99k GitHub stars~1k tokensUpdated today
    Frontend & DesignAuto-check passed
  • Kill AI Slop

    yetone/kill-ai-slop

    Find and remove AI slop — the generic, machine-default visual and copy tics of vibe-coded products — from a web project.

    1.3k GitHub stars~1.4k tokensUpdated 23 days ago
    Frontend & DesignAuto-check passed
  • Official

    Audit a documentation site for agent-friendliness: discovery, markdown delivery, crawlability, semantic structure, machine-readable surfaces, and content legibility.

    4.7k GitHub stars~1.8k tokensUpdated yesterday
    Frontend & DesignAuto-check passed

More from inkline/inkline

All 23 skills in this repo
  • Adversarial QA

    inkline/inkline

    Repro-first QA for Inkline — minimal .ink.tsx reproductions, the visual-parity and cross-target harnesses, fuzz targets, and how to audit teammates' claims.

    1.5k GitHub stars~1.2k tokensUpdated 27 days ago
    Auto-check passed
  • Benchmark Protocol

    inkline/inkline

    How Inkline measures itself — compile performance, output size and quality vs hand-written components and Mitosis, fairness rules, and reporting format.

    1.5k GitHub stars~955 tokensUpdated 27 days ago
    Auto-check passed
  • The Inkline compiler's end-to-end pipeline — parse → IR → analyze → per-target codegen → print — including the IR contracts, reactivity tracking, target rewrite rules, plugin hooks, the two compile…

    1.5k GitHub stars~1.9k tokensUpdated 27 days ago
    Auto-check passed
  • Component Catalog

    inkline/inkline

    How Inkline components are built and kept consistent — the headless/styled split, family anatomy, prop/axis conventions, recipe consumption, the current 5-family catalog and its gap list.

    1.5k GitHub stars~1.4k tokensUpdated 27 days ago
    Auto-check passed
  • Create PR

    inkline/inkline

    Author a pull request in the Guild's standard shape — a fixed Summary / Changes / Verification / Notes skeleton that mirrors the review-gate, plus the hard anti-leak rule that no agent @mention or…

    1.5k GitHub stars~1.7k tokensUpdated 27 days ago
    Auto-check passed
  • How design tokens and recipes flow from styleframe into Inkline — the presets, the two faces of virtual:styleframe, recipe class contracts, theming, and the rules for custom CSS in components.

    1.5k GitHub stars~1.2k tokensUpdated 27 days ago
    Auto-check passed

Questions about Document Component

What does Document Component do?

Phase 5 of building an Inkline component — finalize docs and the release. Document Component is an agent skill from inkline/inkline. Phase 5 of building an Inkline component — finalize docs and the release.

When should I use Document Component?

Document Component fits situations like: wrapping up a component for release; tasks that involve Static sites and blogs.

How do I install Document Component in Claude Code?

Run `npx skills add inkline/inkline --skill document-component -a claude-code`. Or copy the skill folder (.claude/skills/document-component in inkline/inkline) into .claude/skills/document-component in your project. Claude Code loads it when a task matches its description.

How do I install Document Component in Codex?

Run `npx skills add inkline/inkline --skill document-component -a codex`. Or copy the skill folder (.claude/skills/document-component in inkline/inkline) into .agents/skills/document-component in your project. Codex loads it when a task matches its description.

Can I use Document Component 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 inkline/inkline --skill document-component -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/document-component, .gemini/skills/document-component, .github/skills/document-component and .opencode/skills/document-component in your project.

What does Document Component need to run?

Going by SKILL.md and its folder, Document Component needs the command-line tools its instructions call (pnpm). Its frontmatter pre-approves these tools: Read, Write, Edit, Bash.

Does Document Component 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 Document Component safe to install?

Our automated static check of SKILL.md found notes only (pre-approves every shell command (allowed-tools: bash)), nothing it rates as a warning. It is not a guarantee. Review the folder before installing.

What licence does Document Component use?

No licence was found for Document Component or its repository. Without one, default copyright applies: ask the author before reusing or redistributing it.

How many tokens does Document Component use?

About 883 tokens (SKILL.md is roughly 3.5k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Document Component?

Skills that share tags, products or a category with Document Component: Tabler Astro Dev Server (tabler/tabler, 42k stars), Create Docs (victorgarciaesgi/nuxt-typed-router, 413 stars), Tabler Astro Component Scripts (tabler/tabler, 42k stars) and Paperclip Page (paperclipai/paperclip, 99k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Document Component?

inkline (a GitHub organization) maintains it in inkline/inkline, which has 1,469 GitHub stars. The repository holds 23 skills in this directory. The repository was last updated on September 11, 2026.

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