docusaurus-plugins AGENTS.md

docusaurus-plugins AGENTS.md is an instructions file for Claude Code, Codex, OpenCode from gracefullight/docusaurus-plugins. It costs 1,647 tokens per session, scanned A, original, MIT.

Repository instructions for the docusaurus-plugins project. They document its package layout, build and test commands, formatting rules, naming conventions, and TypeScript requirements.

In plain words
What is it for?
They help build and develop Docusaurus plugins, format and lint code, publish packages, and follow the project’s testing and style rules.
Why use it?
They give contributors and coding agents a shared reference for making changes that fit the repository.

Instructions file for Claude CodeCodexOpenCode

Written for Claude Code and Codex and OpenCode: UserPromptSubmit hook event, but also the file is AGENTS.md. Also seen: mentions subagents; mentions AGENTS.md; mentions Codex.

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/gracefullight/docusaurus-plugins/agents-md
Clone the repo
git clone --depth 1 https://github.com/gracefullight/docusaurus-plugins

Made for: Claude Code, Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for docusaurus-plugins AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/gracefullight/docusaurus-plugins/agents-md.svg)](https://agentmods.dev/instructions/gracefullight/docusaurus-plugins/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/gracefullight/docusaurus-plugins/agents-md"><img src="https://agentmods.dev/badge/instructions/gracefullight/docusaurus-plugins/agents-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 1,647 This file is loaded in full into every session.
When invoked 1,647 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.01647 $0.01647
Opus 5 $0.00823 $0.00823
Sonnet 5 $0.00329 $0.00329
Haiku 4.5 $0.00165 $0.00165

Measured 2d ago against content hash d46fba131917, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, from the pricing page.

Security

Grade A, and why

docusaurus-plugins AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 130 lines

How it starts

The opening of the file, as written. The whole thing — 130 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Repository Guidelines

Project Structure & Module Organization

  • packages: Docusaurus plugins (e.g., packages/docusaurus-plugin-sentry) with src/index.ts and built dist/.
  • packages/tsconfig: Shared TS configs.
  • apps: Reserved for examples (currently empty).
  • config: Tooling configs (commitlint, lint-staged).
  • .changeset: Versioning and release metadata.

Build, Test, and Development Commands

  • bun run build: Build all packages via Turbo (dist/**).
  • bun run dev: Watch builds across packages.
  • bun run --filter <pkg> build: Build a single package (e.g., @gracefullight/docusaurus-plugin-sentry).
  • bun run format: Format code with Biome.
  • bun run lint: Lint and auto-fix with Biome.
  • bun run publish-packages: Build + version + publish with Changesets.
  • Requirements: Node 24, bun 1.

Coding Style & Naming Conventions

  • Indentation: 2 spaces; line width 80; LF endings; JS quotes: double (Biome enforced).
  • Filenames: kebab-case (e.g., index.ts, my-plugin.ts).
  • Imports: auto-organized; unused code disallowed by Biome.
  • TypeScript: strict; shared config in packages/tsconfig; package output is CJS with .d.ts.

Testing Guidelines

  • No active test suite in this repo. If adding tests, colocate as *.test.ts next to sources. Avoid test/ folders (excluded from workspace).
  • Aim for small, deterministic unit tests around plugin hooks.

Commit & Pull Request Guidelines

  • Commits: Conventional Commits (e.g., feat:, fix:, docs:). Hooks enforce commitlint and Biome via Husky/lint-staged. Devmoji is available; emoji use is optional.
  • PRs: One focused change per PR. Include a summary, screenshots if UI-related (e.g., example app), and link related issues. Update .changeset with an appropriate bump for affected packages.
  • Naming: Prefer scopes per package (e.g., @gracefullight/docusaurus-plugin-<name>).

Security & Configuration Tips

  • Plugins often inject third-party scripts. Validate IDs/keys via Docusaurus config and avoid committing secrets.
  • Keep external script options minimal and documented in each package README.md.

Read the full file on GitHub · 130 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 130 lines · 1,647 tokens per session scan A d46fba131917

Subscribe to this mod's changes

docusaurus-plugins AGENTS.md is an instructions file published in the GitHub repository gracefullight/docusaurus-plugins (22 stars, last pushed 2mo ago), licensed MIT. It adds 1,647 tokens to every session, about $0.0082 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-03.

Related

Other instructions, from other repositories

planning-with-files AGENTS.md

AGENTS.md instructions for OthmanAdi/planning-with-files, covering agents.md — planning-with-files agent reference card, commit rules, release checklist (12 steps), version bump scope and changelog format.

OthmanAdi/planning-with-files · 2,236 tokens

technocore-chat AGENTS.md

AGENTS.md instructions for flop-labs/technocore-chat: CI runs exactly these — run them before pushing.

flop-labs/technocore-chat · 621 tokens

openrouter-mcp-multimodal AGENTS.md

AGENTS.md instructions for stabgan/openrouter-mcp-multimodal, covering agent instructions, before you ship, releasing (read this before publishing), short version and version files (must all match package.json).

stabgan/openrouter-mcp-multimodal · 793 tokens

OpenMicro AGENTS.md

Instructions for stephenleo/OpenMicro, covering openmicro — project conventions and releases.

stephenleo/OpenMicro · 123 tokens

ai-usagebar CLAUDE.md

Claude Code instructions for akitaonrails/ai-usagebar, covering claude.md, release checklist — must do all of these, hard invariants — never break these, secret-discipline rules (learned the hard way) and live api smoke discipline.

akitaonrails/ai-usagebar · 4,263 tokens

yandex360-mcp CLAUDE.md

Claude Code instructions for pa1ch/yandex360-mcp, covering claude.md — гайд для ассистента, как устроен релиз (всё автоматически по тегу), процедура релиза (шаги ассистента), гарды and архитектура (кратко).

pa1ch/yandex360-mcp · 1,005 tokens