outl markdown.instructions.md

Instructions for outlmd/outl, covering markdown / documentation style and one owner per fact — link, don't duplicate.

Instructions file for GitHub Copilot

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/outlmd/outl/markdown
Clone the repo
git clone --depth 1 https://github.com/outlmd/outl

Made for: GitHub Copilot.

Per session 682 This file is loaded in full into every session.
When invoked 682 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.00682 $0.00682
Opus 5 $0.00341 $0.00341
Sonnet 5 $0.00136 $0.00136
Haiku 4.5 $0.00068 $0.00068

Measured today against content hash d5cccb363f24, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

outl markdown.instructions.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 today.

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.

.github/instructions/markdown.instructions.md · 53 lines

How it starts

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

Markdown / documentation style

Flag when a *.md change introduces hard-wrapped prose (lines broken at ~70/80/100 chars mid-sentence). Every prose *.md in this repo uses semantic line breaks: one sentence per line, breaking after ./!/? (and sometimes :), never at an arbitrary column.

What to flag:

  • Prose paragraphs hard-wrapped at a column width.
  • A sentence split across two or more lines for no reason.
  • Tables rewritten to span multiple lines per row (must stay one row per line).

What to leave alone:

  • Code fences, YAML frontmatter, ASCII tree diagrams — preserve exactly.
  • Outline content (anything under note-example/, real workspace pages, fixtures) — this is data in the outl dialect, not prose docs.
  • Single-line list items, headings, link references.

Scope: root CLAUDE.md, per-crate CLAUDE.md, docs/*.md, README.md, CHANGELOG.md, CONTRIBUTING.md, SECURITY.md, .github/*.md, .claude/agents/*.md, .claude/commands/*.md. Root CLAUDE.md has the canonical rule under "Markdown / documentation style".

Every user-facing fact lives in exactly one docs/*.md. CLAUDE.md files link to it instead of copying the table or chord list.

When reviewing a PR, flag duplication of these surfaces between docs/*.md and any CLAUDE.md:

Fact Canonical home
Every keyboard shortcut (TUI + desktop + mobile) docs/shortcuts.md
outl CLI subcommands docs/cli.md
TUI manual (modes, overlays) docs/tui.md
Outl markdown dialect + sidecar docs/markdown-format.md
CRDT algorithm + invariants docs/crdt.md
Storage trait + JSONL backend docs/storage.md
Sync model docs/sync.md
MCP wiring + recipes docs/mcp.md + docs/mcp-recipes.md
Config file docs/config.md
Theming palette docs/theming.md
Dev loop docs/development.md
Contributing policy docs/contributing.md

What a CLAUDE.md should carry: invariants, architectural decisions you don't get to revisit, crate-specific contracts, the reasoning behind a choice — things a contributor needs before touching code, not user reference.

Read the full file on GitHub · 53 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. today First seen · 53 lines · 682 tokens per session scan A d5cccb363f24

Subscribe to this mod's changes

outl markdown.instructions.md is an instructions file published in the GitHub repository outlmd/outl (161 stars, last pushed yesterday), licensed MIT. It adds 682 tokens to every session, about $0.0034 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-01.