guidelines-for-writing-markdown-documents

guidelines-for-writing-markdown-documents is a cursor rule for Cursor from fumito-ito/mdcvalult. It costs 0 tokens per session (762 once invoked), scanned A, a copy of 400-md-docs, MIT.

A set of rules for writing readable Markdown documents, the plain-text format commonly used for project documentation and README files.

In plain words
What is it for?
Use it whenever creating or updating Markdown, including choosing heading levels, adding YAML front matter, formatting code blocks, and using diagrams when useful.
Why use it?
It keeps headings, metadata, code examples, callouts, and other document parts consistent.

Cursor rule for Cursor

Written for Cursor: a Cursor rule (.mdc).

Good fit Use it whenever creating or updating Markdown, including choosing heading levels, adding YAML front matter, formatting code blocks, and using diagrams when useful.

Compare 6 cursor rules from other repositories ↓
Install with agentmods
npx agentmods add rules/fumito-ito/mdcvalult/guidelines-for-writing-markdown-documents
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.

Clone the repo
git clone --depth 1 https://github.com/fumito-ito/mdcvalult

Made for: Cursor.

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 guidelines-for-writing-markdown-documents

README.md
[![agentmods](https://agentmods.dev/badge/rules/fumito-ito/mdcvalult/guidelines-for-writing-markdown-documents.svg)](https://agentmods.dev/rules/fumito-ito/mdcvalult/guidelines-for-writing-markdown-documents)
Your own site
<a href="https://agentmods.dev/rules/fumito-ito/mdcvalult/guidelines-for-writing-markdown-documents"><img src="https://agentmods.dev/badge/rules/fumito-ito/mdcvalult/guidelines-for-writing-markdown-documents.svg" alt="Measured on agentmods" height="20"></a>
Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 762 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin 92% copy Near-identical to another mod 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.00000 $0.00762
Opus 5 $0.00000 $0.00381
Sonnet 5 $0.00000 $0.00152
Haiku 4.5 $0.00000 $0.00076

Measured 8d ago against content hash 91765a6ec75f, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-07, from the pricing page.

Security

Grade A, and why

guidelines-for-writing-markdown-documents 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 8d 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.

Origin

This is a copy

92% identical to 400-md-docs — 1 line differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

mdc/guidelines-for-writing-markdown-documents.mdc · 135 lines

How it starts

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

Markdown Documentation Standards

Requirements

  • Follow the official Markdown Guide for all basic and extended syntax
  • Maintain clear document structure and readability
  • Include appropriate metadata when required
  • Use Mermaid diagrams for visual documentation where appropriate
  • Always Include YAML front matter for metadata but Keep metadata concise

Markdown Reference

For all basic and extended Markdown syntax, refer to:

Formatting Rules

  • Use ATX-style headings with space after hash: # Heading
  • Maintain proper heading hierarchy (don't skip levels)
  • Maximum heading depth: 4 levels
  • Add blank line before and after headings
  • Indent content within XML tags by 2 spaces
  • Close XML tags on their own line at the parent indentation level
  • Use blockquotes with emoji for different types of callouts:

💡 Tip: Helpful suggestion.

ℹ️ Note: Additional context.

Code Blocks

  • Use triple backticks with language specification
  • Indent code blocks properly
  • Add blank line before and after
  • Use inline code for short references

Reference the example() function inline.

Tables

  • Use alignment indicators
  • Include header row separator
  • Keep tables simple and readable
  • Add blank lines before and after

Special Elements

Callouts

Use blockquotes with emoji for different types of callouts:

💡 Tip: Helpful suggestion.

ℹ️ Note: Additional context.

Read the full file on GitHub · 135 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. 8d ago First seen · 135 lines · 762 tokens per session scan A 91765a6ec75f

Subscribe to this mod's changes

guidelines-for-writing-markdown-documents is a cursor rule published in the GitHub repository fumito-ito/mdcvalult (33 stars, last pushed 1y ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 762 tokens. A static security scan graded it A with 0 findings. It is 92% identical to 400-md-docs, differing in 1 line, and is treated as a copy.