What is markdown_documentation?

A set of rules for writing Markdown documentation that is accurate, concise, professional, and easy to navigate. Markdown is a plain-text format commonly used for README files and technical documents.

Use it when creating or updating README files, guides, reference pages, and other Markdown documents.

It reduces unclear structure, outdated information, repetition, and inconsistent formatting in documentation.

markdown_documentation — Cursor rule by jpke

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 rules/jpke/cursor-vibe-coding-template/markdown_documentation

Clone the repo

git clone --depth 1 https://github.com/jpke/cursor-vibe-coding-template

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.

When invoked 498 The whole file, excluding the scripts and references it only reads on demand.

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.

Model	Per session	Once invoked
Fable 5	$0.00000	$0.00498
Opus 5	$0.00000	$0.00249
Sonnet 5	$0.00000	$0.00100
Haiku 4.5	$0.00000	$0.00050

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

Security

Grade A, and why

markdown_documentation 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 yesterday.

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.

.cursor/rules/markdown_documentation.mdc · 60 lines

How it starts

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

Markdown Documentation Standards

Core Principles

Accuracy: All information must be current, tested, and factually correct
Conciseness: Communicate maximum value with minimum words
Professionalism: Use clear, consistent tone and proper formatting

Content Organization

Information Hierarchy

Lead with value: Most critical information in first 2-3 paragraphs
Progressive disclosure: Details follow overview, specifics follow general
Scannable structure: Use headings, bullets, and whitespace strategically

Content Quality

Eliminate duplication: Each piece of information appears once
Link don't repeat: Reference other sections rather than duplicating content
Update holistically: When changing one section, review related sections

Structure Requirements

Navigation

Table of Contents: For files >200 lines or >5 main sections
Consistent headings: Use semantic hierarchy (H1 → H2 → H3)
Cross-references: Link related sections and external resources

Formatting Standards

Code blocks: Always specify language (json, bash, typescript)
Lists: Use bullets for items, numbers for sequential steps
Tables: For structured data comparison
Callouts: Use > for important notes, warnings, or tips

File-Specific Guidelines

README.md

Hook: Project purpose in first sentence
Quick start: Installation/usage in first section
Core features: Key functionality overview
Developer info: Setup, contributing, license

Technical Documentation

Prerequisites: Required knowledge, tools, versions
Examples: Working code snippets, not pseudo-code
Troubleshooting: Common issues with solutions
References: Links to official docs, RFCs, specifications

Quality Checks

Information is current and accurate
No duplicate content across sections
Most important info appears early
Structure enables quick scanning
All code examples work as written
Links are functional and relevant

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

yesterday First seen · 60 lines · 0 tokens per session scan A 5ed01d6c8706

Subscribe to this mod's changes

markdown_documentation is a cursor rule published in the GitHub repository jpke/cursor-vibe-coding-template (16 stars, last pushed 1y ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 498 tokens. 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.

Productivity Writing and docs ai-coding ai-development cursor development-workflow mcp project-template

markdown_documentation