Markdown Formatting Rules

Name: Markdown Formatting Rules
Author: michaelgainford

Use when creating or updating Markdown docs. Enforces markdownlint-safe formatting for headings, lists, spacing, links, and trailing spaces.

by michaelgainford(0) 0 installs

Free

Free account. Installing gives you the manifest plus copy-paste snippets.

See reviews

About

Instruction file imported from michaelgainford/michaelgainford.github.io (.github/instructions/markdown-formatting.instructions.md). Copyright stays with the author.

Markdown Formatting Rules

Always keep one blank line around headings.
Always keep one blank line around lists.
Do not leave trailing spaces.
Use Markdown links for URLs instead of bare URLs.
Prefer concise lines and wrap long paragraphs where practical.
After editing Markdown files, run npx markdownlint-cli2 *.md from the repo root and fix any reported issues.

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

yaml

targets:
  - https://api.opensmartroute.ai/api/v1/registry/michaelgainford-michaelgainford-github-io-markdown-forma-61ffc3/manifest   # or paste the manifest below

michaelgainford-michaelgainford-github-io-markdown-forma-61ffc3.ocm.jsonjson

{
  "ocm": "1",
  "id": "michaelgainford-michaelgainford-github-io-markdown-forma-61ffc3",
  "kind": "skill",
  "name": "Markdown Formatting Rules",
  "description": "Use when creating or updating Markdown docs. Enforces markdownlint-safe formatting for headings, lists, spacing, links, and trailing spaces.",
  "publisher": "michaelgainford",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "general"
    ],
    "tags": [
      "skill-md",
      "github-instructions"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "Use when creating or updating Markdown docs. Enforces markdownlint-safe formatting for headings, lists, spacing, links, and trailing spaces."
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "github-instructions",
      "repository": "https://github.com/michaelgainford/michaelgainford.github.io",
      "path": ".github/instructions/markdown-formatting.instructions.md",
      "ref": "a29762b7770b01a87686f999369b57eb38d7d205",
      "url": "https://github.com/michaelgainford/michaelgainford.github.io/blob/a29762b7770b01a87686f999369b57eb38d7d205/.github/instructions/markdown-formatting.instructions.md",
      "key": "michaelgainford/michaelgainford.github.io/.github/instructions/markdown-formatting.instructions.md"
    },
    "applies_to": "**/*.md"
  },
  "instructions": "# Markdown Formatting Rules\n\n- Always keep one blank line around headings.\n- Always keep one blank line around lists.\n- Do not leave trailing spaces.\n- Use Markdown links for URLs instead of bare URLs.\n- Prefer concise lines and wrap long paragraphs where practical.\n- After editing Markdown files, run `npx markdownlint-cli2 *.md` from the repo root and fix any reported issues.",
  "cost": {
    "context_tokens": 94
  }
}

Fetch it by URL: GET /api/v1/registry/michaelgainford-michaelgainford-github-io-markdown-forma-61ffc3/manifest?version=1.0.0

Markdown Formatting Rules

About

Markdown Formatting Rules

Use it

Manifest

Reviews