Official agent skill

Docs Components

by reactjs in reactjs/ar.react.dev

Comprehensive MDX component patterns (Note, Pitfall, DeepDive, Recipes, etc.) for all documentation types.

OfficialCC-BY-4.0Auto-check passedDocuments & Office

Install Docs Components

skills CLI
$ npx skills add reactjs/ar.react.dev --skill docs-components -a claude-code

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

GitHub CLI
$ gh skill install reactjs/ar.react.dev docs-components --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/reactjs/ar.react.dev.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/docs-components .claude/skills/docs-components && 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
docs-components
GitHub stars
164
Token cost
~3k tokens
SKILL.md length
629 words
Files
1
Skills in repo
10
Repo updated
First seen
Licence
CC-BY-4.0

At a glance

Comprehensive MDX component patterns (Note, Pitfall, DeepDive, Recipes, etc.) for all documentation types.

  • Tasks that involve Markdown
  • SKILL.md covers Quick Reference, and, (Use Sparingly) and Component Usage by Page Type, plus 1 more section
  • Reaches en.wikipedia.org
  • Tasks that involve Deployment

What it does

Docs Components is an agent skill from reactjs/ar.react.dev, published by the product's own GitHub organization. Comprehensive MDX component patterns (Note, Pitfall, DeepDive, Recipes, etc.) for all documentation types. Authoritative source for component usage, examples, and heading conventions.

Its SKILL.md is about 3k 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 Documents & Office, covering Markdown and Deployment. The repository describes itself as: React documentation website in Arabic 📘⚛️ — وثائق React باللغة العربية. The licence is CC-BY-4.0.

When your agent uses it

  • Tasks that involve Markdown
  • Tasks that involve Deployment

Example prompts

  • “/docs-components”

What it can do on your machine

Read from SKILL.md and the folder at commit 2da48d6. 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

    No scripts in the folder and no shell commands in SKILL.md (its code samples are mdx).

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

  • Network

    Hosts in commands or code, which the agent is likely to contact:

    • en.wikipedia.org

    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

Docs Components loads about 3k tokens when it runs. Until then it costs about 50 tokens; SKILL.md has 629 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~50
When it runs · the whole SKILL.md, loaded when a task matches
~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

The full file from reactjs/ar.react.dev at commit 2da48d6, republished under its CC-BY-4.0 licence (© reactjs). 629 words, ~2,960 tokens.

Download SKILL.mdSave it as .claude/skills/docs-components/SKILL.md (or your agent's skills folder).
name
docs-components
description
Comprehensive MDX component patterns (Note, Pitfall, DeepDive, Recipes, etc.) for all documentation types. Authoritative source for component usage, examples, and heading conventions.

MDX Component Patterns

Quick Reference

Component Decision Tree
NeedComponent
Helpful tip or terminology<Note>
Common mistake warning<Pitfall>
Advanced technical explanation<DeepDive>
Canary-only feature<Canary> or <CanaryBadge />
Server Components only<RSC>
Deprecated API<Deprecated>
Experimental/WIP<Wip>
Visual diagram<Diagram>
Multiple related examples<Recipes>
Interactive code<Sandpack> (see /docs-sandpack)
Console error display<ConsoleBlock>
End-of-page exercises<Challenges> (Learn pages only)
Heading Level Conventions
ComponentHeading Level
DeepDive title#### (h4)
Titled Pitfall##### (h5)
Titled Note#### (h4)
Recipe items#### (h4)
Challenge items#### (h4)
Callout Spacing Rules

Callout components (Note, Pitfall, DeepDive) require a blank line after the opening tag before content begins.

Never place consecutively:

  • <Pitfall> followed by <Pitfall> - Combine into one with titled subsections, or separate with prose
  • <Note> followed by <Note> - Combine into one, or separate with prose

Allowed consecutive patterns:

  • <DeepDive> followed by <DeepDive> - OK for multi-part explorations (see useMemo.md)
  • <Pitfall> followed by <DeepDive> - OK when DeepDive explains "why" behind the Pitfall

Separation content: Prose paragraphs, code examples (Sandpack), or section headers.

Why: Consecutive warnings create a "wall of cautions" that overwhelms readers and causes important warnings to be skimmed.

Incorrect:

mdx
<Pitfall>
Don't do X.
</Pitfall>

<Pitfall>
Don't do Y.
</Pitfall>

Correct - combined:

mdx
<Pitfall>

##### Don't do X {/*pitfall-x*/}
Explanation.

##### Don't do Y {/*pitfall-y*/}
Explanation.

</Pitfall>

Correct - separated:

mdx
<Pitfall>
Don't do X.
</Pitfall>

This leads to another common mistake:

<Pitfall>
Don't do Y.
</Pitfall>

<Note>

Important clarifications, conventions, or tips. Less severe than Pitfall.

Simple Note
mdx
<Note>

The optimization of caching return values is known as [_memoization_](https://en.wikipedia.org/wiki/Memoization).

</Note>
Note with Title

Use #### (h4) heading with an ID.

mdx
<Note>

#### There is no directive for Server Components. {/*no-directive*/}

A common misunderstanding is that Server Components are denoted by `"use server"`, but there is no directive for Server Components. The `"use server"` directive is for Server Functions.

</Note>
Version-Specific Note
mdx
<Note>

Starting in React 19, you can render `<SomeContext>` as a provider.

In older versions of React, use `<SomeContext.Provider>`.

</Note>

<Pitfall>

Common mistakes that cause bugs. Use for errors readers will likely make.

Simple Pitfall
mdx
<Pitfall>

We recommend defining components as functions instead of classes. [See how to migrate.](#alternatives)

</Pitfall>
Titled Pitfall

Use ##### (h5) heading with an ID.

mdx
<Pitfall>

##### Calling different memoized functions will read from different caches. {/*pitfall-different-caches*/}

To access the same cache, components must call the same memoized function.

</Pitfall>
Pitfall with Wrong/Right Code
mdx
<Pitfall>

##### `useFormStatus` will not return status information for a `<form>` rendered in the same component. {/*pitfall-same-component*/}

```js
function Form() {
  // 🔴 `pending` will never be true
  const { pending } = useFormStatus();
  return <form action={submit}></form>;
}

Instead call useFormStatus from inside a component located inside <form>.

</Pitfall>
```

<DeepDive>

Optional deep technical content. First child must be #### heading with ID.

Standard DeepDive
mdx
<DeepDive>

#### Is using an updater always preferred? {/*is-updater-preferred*/}

You might hear a recommendation to always write code like `setAge(a => a + 1)` if the state you're setting is calculated from the previous state. There's no harm in it, but it's also not always necessary.

In most cases, there is no difference between these two approaches. React always makes sure that for intentional user actions, like clicks, the `age` state variable would be updated before the next click.

</DeepDive>
Comparison DeepDive

For comparing related concepts:

mdx
<DeepDive>

#### When should I use `cache`, `memo`, or `useMemo`? {/*cache-memo-usememo*/}

All mentioned APIs offer memoization but differ in what they memoize, who can access the cache, and when their cache is invalidated.

#### `useMemo` {/*deep-dive-usememo*/}

In general, you should use `useMemo` for caching expensive computations in Client Components across renders.

#### `cache` {/*deep-dive-cache*/}

In general, you should use `cache` in Server Components to memoize work that can be shared across components.

</DeepDive>

<Recipes>

Multiple related examples showing variations. Each recipe needs <Solution />.

mdx
<Recipes titleText="Basic useState examples" titleId="examples-basic">

#### Counter (number) {/*counter-number*/}

In this example, the `count` state variable holds a number.

<Sandpack>
{/* code */}
</Sandpack>

<Solution />

#### Text field (string) {/*text-field-string*/}

In this example, the `text` state variable holds a string.

<Sandpack>
{/* code */}
</Sandpack>

<Solution />

</Recipes>

Common titleText/titleId combinations:

  • "Basic [hookName] examples" / examples-basic
  • "Examples of [concept]" / examples-[concept]
  • "The difference between [A] and [B]" / examples-[topic]

<Challenges>

End-of-page exercises. Learn pages only. Each challenge needs problem + solution Sandpack.

mdx
<Challenges>

#### Fix the bug {/*fix-the-bug*/}

Problem description...

<Hint>
Optional hint text.
</Hint>

<Sandpack>
{/* problem code */}
</Sandpack>

<Solution>

Explanation...

<Sandpack>
{/* solution code */}
</Sandpack>

</Solution>

</Challenges>

Guidelines:

  • Only at end of standard Learn pages
  • No Challenges in chapter intros or tutorials
  • Each challenge has #### heading with ID

<Deprecated>

For deprecated APIs. Content should explain what to use instead.

Page-Level Deprecation
mdx
<Deprecated>

In React 19, `forwardRef` is no longer necessary. Pass `ref` as a prop instead.

`forwardRef` will be deprecated in a future release. Learn more [here](/blog/2024/04/25/react-19#ref-as-a-prop).

</Deprecated>
Method-Level Deprecation
mdx
### `componentWillMount()` {/*componentwillmount*/}

<Deprecated>

This API has been renamed from `componentWillMount` to [`UNSAFE_componentWillMount`.](#unsafe_componentwillmount)

Run the [`rename-unsafe-lifecycles` codemod](codemod-link) to automatically update.

</Deprecated>

<RSC>

For APIs that only work with React Server Components.

Basic RSC
mdx
<RSC>

`cache` is only for use with [React Server Components](/reference/rsc/server-components).

</RSC>
Extended RSC (for Server Functions)
mdx
<RSC>

Server Functions are for use in [React Server Components](/reference/rsc/server-components).

**Note:** Until September 2024, we referred to all Server Functions as "Server Actions".

</RSC>

<Canary> and <CanaryBadge />

For features only available in Canary releases.

Canary Wrapper (inline in Intro)
mdx
<Intro>

`<Fragment>` lets you group elements without a wrapper node.

<Canary>Fragments can also accept refs, enabling interaction with underlying DOM nodes.</Canary>

</Intro>
CanaryBadge in Section Headings
mdx
### <CanaryBadge /> FragmentInstance {/*fragmentinstance*/}
CanaryBadge in Props Lists
mdx
* <CanaryBadge /> **optional** `ref`: A ref object from `useRef` or callback function.
CanaryBadge in Caveats
mdx
* <CanaryBadge /> If you want to pass `ref` to a Fragment, you can't use the `<>...</>` syntax.

Show full SKILL.md (258 more words)Show less

<Diagram>

Visual explanations of module dependencies, render trees, or data flow.

mdx
<Diagram name="use_client_module_dependency" height={250} width={545} alt="A tree graph with the top node representing the module 'App.js'. 'App.js' has three children...">
`'use client'` segments the module dependency tree, marking `InspirationGenerator.js` and all dependencies as client-rendered.
</Diagram>

Attributes:

  • name: Diagram identifier (used for image file)
  • height: Height in pixels
  • width: Width in pixels
  • alt: Accessible description of the diagram

<CodeStep> (Use Sparingly)

Numbered callouts in prose. Pairs with code block annotations.

Syntax

In code blocks:

mdx
```js [[1, 4, "age"], [2, 4, "setAge"], [3, 4, "42"]]
import { useState } from 'react';

function MyComponent() {
  const [age, setAge] = useState(42);
}

Format: `[[step_number, line_number, "text_to_highlight"], ...]`

In prose:
```mdx
1. The <CodeStep step={1}>current state</CodeStep> initially set to the <CodeStep step={3}>initial value</CodeStep>.
2. The <CodeStep step={2}>`set` function</CodeStep> that lets you change it.
Guidelines
  • Maximum 2-3 different colors per explanation
  • Don't highlight every keyword - only key concepts
  • Use for terms in prose, not entire code blocks
  • Maintain consistent usage within a section

✅ Good use - highlighting key concepts:

mdx
React will compare the <CodeStep step={2}>dependencies</CodeStep> with the dependencies you passed...

🚫 Avoid - excessive highlighting:

mdx
When an <CodeStep step={1}>Activity</CodeStep> boundary is <CodeStep step={2}>hidden</CodeStep> during its <CodeStep step={3}>initial</CodeStep> render...

<ConsoleBlock>

Display console output (errors, warnings, logs).

mdx
<ConsoleBlock level="error">
Uncaught Error: Too many re-renders.
</ConsoleBlock>

Levels: error, warning, info


Component Usage by Page Type

Reference Pages

For component placement rules specific to Reference pages, invoke /docs-writer-reference.

Key placement patterns:

  • <RSC> goes before <Intro> at top of page
  • <Deprecated> goes after <Intro> for page-level deprecation
  • <Deprecated> goes after method heading for method-level deprecation
  • <Canary> wrapper goes inline within <Intro>
  • <CanaryBadge /> appears in headings, props lists, and caveats
Learn Pages

For Learn page structure and patterns, invoke /docs-writer-learn.

Key usage patterns:

  • Challenges only at end of standard Learn pages
  • No Challenges in chapter intros or tutorials
  • DeepDive for optional advanced content
  • CodeStep should be used sparingly
Blog Pages

For Blog page structure and patterns, invoke /docs-writer-blog.

Key usage patterns:

  • Generally avoid deep technical components
  • Note and Pitfall OK for clarifications
  • Prefer inline explanations over DeepDive

Other Available Components

Version/Status: <Experimental>, <ExperimentalBadge />, <RSCBadge />, <NextMajor>, <Wip>

Visuals: <DiagramGroup>, <Illustration>, <IllustrationBlock>, <CodeDiagram>, <FullWidth>

Console: <ConsoleBlockMulti>, <ConsoleLogLine>

Specialized: <TerminalBlock>, <BlogCard>, <TeamMember>, <YouTubeIframe>, <ErrorDecoder />, <LearnMore>, <Math>, <MathI>, <LanguageList>

See existing docs for usage examples of these components.

© reactjs, CC-BY-4.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .claude/skills/docs-components of reactjs/ar.react.dev.

Open the folder on GitHubat commit 2da48d6

Used in 3 other repositories

We found 3 copies of this SKILL.md (exact, near-identical or edited) in other folders. This page covers the copy in reactjs/ar.react.dev, which our catalogue first saw on October 7, 2026.

Compare with similar skills

Docs Components 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.

Docs Components compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Docs Components this skillreactjs/ar.react.dev164—~3kAutomated safety check: PassCC-BY-4.0
Markdown Article FormatterJimLiu/baoyu-skills26k7 repos~3.5kAutomated safety check: PassMIT
MarkitdownImCa0/just-laws78114 repos~3.2kAutomated safety check: NotesMIT
Obsidian MarkdownAtmosphere/atmosphere3.8k20 repos~1.3kAutomated safety check: PassApache-2.0
Gzh Designisjiamu/gzh-design-skill3.9k1 repos~2.2kAutomated safety check: PassAGPL-3.0
Crosspostingwasp-lang/wasp19k—~1.1kAutomated safety check: PassMIT

Similar skills

  • Markdown Article Formatter

    JimLiu/baoyu-skills

    Reformats plain text or Markdown articles with frontmatter, a title, a summary, headings, bold, lists and code blocks, and saves a separate formatted copy.

    26k GitHub starsUsed in 7 repos~3.5k tokens
    Documents & OfficeAuto-check passed
  • Markitdown

    ImCa0/just-laws

    Convert files and office documents to Markdown. An agent skill from ImCa0/just-laws.

    781 GitHub starsUsed in 14 repos~3.2k tokens
    Documents & OfficeAuto-check: notes
  • Obsidian Markdown

    Atmosphere/atmosphere

    Create and edit Obsidian Flavored Markdown with wikilinks, embeds, callouts, properties, and other Obsidian-specific syntax.

    3.8k GitHub starsUsed in 20 repos~1.3k tokens
    Documents & OfficeAuto-check passed
  • Gzh Design

    isjiamu/gzh-design-skill

    微信公众号文章排版引擎,将 Markdown 转换为可直接粘贴到公众号编辑器的 HTML。主题风格从 references/theme-index.md 注册的自定义主题库中选取,自动章节编号、关键词下划线标记、引言卡片、目录导航、代码块、图片/GIF、作者签名。支持 Markdown / Word(.docx) / PDF / 纯文本输入(非 Markdown…

    3.9k GitHub starsUsed in 1 repo~2.2k tokens
    Documents & OfficeAuto-check passed
  • Crossposting

    wasp-lang/wasp

    Crosspost Wasp blog articles (MDX) to DEV.to and Medium. An agent skill from wasp-lang/wasp.

    19k GitHub stars~1.1k tokensUpdated today
    Documents & OfficeAuto-check passed
  • Review The Docs

    supabase/supabase

    Official

    Review Supabase docs changes locally in your supabase/supabase checkout — either an open PR (triage, classify, verify) or your own branch before opening a PR (local self-review).

    111k GitHub stars~4.6k tokensUpdated today
    Documents & OfficeAuto-check passed

More from reactjs/ar.react.dev

All 10 skills in this repo
  • React Expert

    reactjs/ar.react.dev

    Official

    A skill your agent uses when researching React APIs or concepts for documentation.

    164 GitHub starsUsed in 2 repos~2.7k tokens
    Auto-check passed
  • Docs Rsc Sandpack

    reactjs/ar.react.dev

    Official

    A skill your agent uses when adding interactive RSC (React Server Components) code examples to React docs using <SandpackRSC, or when modifying the RSC sandpack infrastructure.

    164 GitHub stars~2.1k tokensUpdated 3 days ago
    Auto-check passed
  • Docs Voice

    reactjs/ar.react.dev

    Official

    A skill your agent uses when writing any React documentation.

    164 GitHub stars~1.2k tokensUpdated 3 days ago
    Auto-check passed
  • Docs Writer Blog

    reactjs/ar.react.dev

    Official

    A skill your agent uses when writing or editing files in src/content/blog/.

    164 GitHub stars~4.2k tokensUpdated 3 days ago
    Auto-check passed
  • Docs Writer Learn

    reactjs/ar.react.dev

    Official

    A skill your agent uses when writing or editing files in src/content/learn/.

    164 GitHub stars~1.8k tokensUpdated 3 days ago
    Auto-check passed
  • Write

    reactjs/ar.react.dev

    Official

    A skill your agent uses when creating new React documentation pages or updating existing ones.

    164 GitHub stars~1.6k tokensUpdated 3 days ago
    Auto-check passed

Questions about Docs Components

What does Docs Components do?

Comprehensive MDX component patterns (Note, Pitfall, DeepDive, Recipes, etc.) for all documentation types. dev, published by the product's own GitHub organization.) for all documentation types.

When should I use Docs Components?

Docs Components fits situations like: tasks that involve Markdown; tasks that involve Deployment.

How do I install Docs Components in Claude Code?

Run `npx skills add reactjs/ar.react.dev --skill docs-components -a claude-code`. Or copy the skill folder (.claude/skills/docs-components in reactjs/ar.react.dev) into .claude/skills/docs-components in your project. Claude Code loads it when a task matches its description.

How do I install Docs Components in Codex?

Run `npx skills add reactjs/ar.react.dev --skill docs-components -a codex`. Or copy the skill folder (.claude/skills/docs-components in reactjs/ar.react.dev) into .agents/skills/docs-components in your project. Codex loads it when a task matches its description.

Can I use Docs Components 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 reactjs/ar.react.dev --skill docs-components -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/docs-components, .gemini/skills/docs-components, .github/skills/docs-components and .opencode/skills/docs-components in your project.

What does Docs Components need to run?

SKILL.md names no scripts, command-line tools or credentials: Docs Components is instructions for the agent only.

Does Docs Components access the network?

SKILL.md names 1 domain. In commands or code: en.wikipedia.org; the agent is likely to contact it when it follows the instructions. This is read from the text; nothing was executed.

Is Docs Components 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 Docs Components use?

Docs Components is published under the CC-BY-4.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Docs Components use?

About 3k tokens (SKILL.md is roughly 12k 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 Docs Components?

Skills that share tags, products or a category with Docs Components: Markdown Article Formatter (JimLiu/baoyu-skills, 26k stars), Markitdown (ImCa0/just-laws, 781 stars), Obsidian Markdown (Atmosphere/atmosphere, 3.8k stars) and Gzh Design (isjiamu/gzh-design-skill, 3.9k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Docs Components?

reactjs (a GitHub organization, an official publisher) maintains it in reactjs/ar.react.dev, which has 164 GitHub stars. The repository holds 10 skills in this directory. The repository was last updated on October 5, 2026.

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