What is markit AGENTS.md?

Project instructions for Markit, a tool that converts documents, web pages, media, and other files into Markdown, a plain-text format for structured documents. The conversion engine is written in Rust, while the Node.js and TypeScript code provides the command line and programming interface.

Use it when adding or changing supported conversions, the Node.js interface, or the command-line tool, and when running the related Rust and TypeScript tests and checks.

It makes clear where conversion code belongs and which checks to run after changes. This helps prevent changes to the thin interface layer from being mistaken for changes to the conversion engine.

How shift-labs-ai/markit configures Codex and OpenCode

About the project

markit is a command-line tool and library that converts documents, web content, media metadata, archives, code, and other inputs into Markdown. It is for developers and agents that need consistent Markdown representations of files or URLs. Catalogue add-ons help coding agents use markit.

shift-labs-ai/markit · 1,326 stars · on GitHub

Reuse

Borrowing it

Nothing to install: this file belongs to shift-labs-ai/markit. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/shift-labs-ai/markit/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/shift-labs-ai/markit

Made for: 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.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/shift-labs-ai/markit/agents-md/github.svg)](https://agentmods.dev/instructions/shift-labs-ai/markit/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/shift-labs-ai/markit/agents-md"><img src="https://agentmods.dev/badge/instructions/shift-labs-ai/markit/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/shift-labs-ai/markit/agents-md"><img src="https://agentmods.dev/badge/instructions/shift-labs-ai/markit/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 594 This file is loaded in full into every session.

When invoked 594 The same file — it is already loaded in full.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

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.

Model	Per session	Once invoked
Fable 5.1	$0.00594	$0.00594
Opus 5.5	$0.00238	$0.00238
Sonnet 5.5	$0.00119	$0.00119
Haiku 4.5	$0.00059	$0.00059

Measured 1mo ago against content hash 5775c66df2dd, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

markit 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 1mo 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 · 49 lines

How it starts

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

markit

Convert anything to markdown. PDF, DOCX, PPTX, XLSX, HTML, EPUB, Jupyter notebooks, RSS, images, audio, URLs, Wikipedia, GitHub, iWork, XML, YAML, CSV, JSON, ZIP — everything gets milled. Rust is the sole conversion engine; TypeScript is only the thin Node SDK and CLI shell.

Commands

bun run build:native                   # Build the Rust N-API addon
bun run dev -- <file-or-url>           # Dev — convert through native Rust
bun run dev -- convert <file-or-url>   # Explicit convert command
bun run dev -- formats                 # List supported formats
bun test                               # Node SDK contract tests
bun run check                          # Biome lint + format (thin TS shell)
cd rust && cargo test                  # Engine tests
bun run check:rust                     # rustfmt --check + clippy -D warnings
bun run check:all                      # Both sides

The sole conversion implementation lives in rust/; src/ is only the typed N-API loader and npm CLI shell. Run Rust tests for conversion changes and both suites for binding/public API changes. Lint policy is in rust/Cargo.toml [lints.clippy].

Architecture

rust/src/markit.rs — sole converter registry and URL/file/buffer SDK
rust/src/converters/ — one Rust implementation per format
rust/src/bindings.rs — async N-API surface
src/native-markit.ts — thin typed wrappers over the native addon
src/main.ts / src/commands/ — npm CLI shell
src/types.ts — public Node SDK interfaces
native.cjs — platform-native addon loader

Key Patterns

Converter interface: Each Rust converter implements name, accepts(info), and convert(input, info). Optional convert_url() handles URL-first converters.
Priority order: Specific formats first (pdf, docx), generic last (plain-text as catch-all)
Output triple: Every command supports --json, --quiet, and human-readable output
URL support: markit https://example.com fetches and converts. Converters with convertUrl() can handle fetching themselves.
Optional deps: xlsx is a dynamic import — fails gracefully with install instructions

Read the full file on GitHub · 49 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.

1mo ago First seen · 49 lines · 594 tokens per session scan A 5775c66df2dd

Subscribe to this mod's changes

markit AGENTS.md is an instructions file published in the GitHub repository shift-labs-ai/markit (1,326 stars, last pushed 2mo ago), licensed MIT. It adds 594 tokens to every session, about $0.0024 per session on Opus 5.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-08-30.

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 9,715 tokens

markit: Instructions file for Codex

Borrowing it

Wrote this? Show the measurements

What it costs to keep this loaded

Grade A, and why

Nothing flagged

How it starts

markit

Commands

Architecture

Key Patterns

What this file has done since we first saw it

Other instructions, from other repositories

vscode buildNext.instructions.md

next.js AGENTS.md

vscode oss-third-party-notices.instructions.md

langchain AGENTS.md

vscode copilot-instructions.md

deepseek-harness AGENTS.md