agentleFS
Twodragon0Twodragon0/claudesec/.cursor/rules/markdown-quality.mdc

claudesec / rules

Cursor rule16 starsChanged 6 months agoMITView on GitHub

Markdown docs — frontmatter, code blocks, links, markdownlint

The file

We split this markdown-quality.mdc into the rules it gives an agent

3 rules. About 0 are common, 2 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Every Markdown doc must have YAML frontmatter with:

    line 11
  2. Very specific:

    Always set the language (e.g.

    line 27
  3. Distinctive:

    All Markdown must pass markdownlint before commit.

    line 33

≈ “Common” is an estimate: at least 1 in 5 of the 6,668 Cursor rule files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
markdown-quality.mdc
---
description: Markdown docs — frontmatter, code blocks, links, markdownlint
globs: "**/*.md"
alwaysApply: false
---

# Markdown Quality (ClaudeSec)

## Frontmatter

Every Markdown doc must have YAML frontmatter with:

- `title` — short document title
- `description` — one-line summary
- `tags` — list of tags (e.g. `["devsecops", "github"]`)

```yaml
---
title: GitHub Actions Security
description: Secure CI/CD with GitHub Actions
tags: [github, ci-cd, security]
---
```

## Code Blocks

- Always set the **language** (e.g. ` ```bash `, ` ```yaml `).
- Code examples must be **tested and runnable**; avoid pseudocode unless explicitly noted.

## Links & Lint

- Links must be **valid** (no broken references).
- All Markdown must pass **markdownlint** before commit.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.