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.

In plain words
What is it for?
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.
Why use it?
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.

Instructions file for CodexOpenCode

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/shift-labs-ai/markit/agents-md
Clone the repo
git clone --depth 1 https://github.com/shift-labs-ai/markit

Made for: Codex, OpenCode.

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. 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 $0.00594 $0.00594
Opus 5 $0.00297 $0.00297
Sonnet 5 $0.00119 $0.00119
Haiku 4.5 $0.00059 $0.00059

Measured 3d ago against content hash 5775c66df2dd, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, 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 3d 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.

  1. 3d 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,317 stars, last pushed 15d ago), licensed MIT. It adds 594 tokens to every session, about $0.0030 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-08-30.

Related

Other instructions, from other repositories

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 · 6,785 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,345 tokens

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

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

next.js AGENTS.md

Instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens