OpenParable
Skip to content
← Back to skills

Formatting Lint

Documents
formatting-lint

Formatting Lint is an Agent Skill for documents published in the MicrosoftDocs/cloud-adoption-framework repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Checks Markdown formatting including code fences, alert syntax, list markers, and table structure. Use when asked to lint or fix Markdown formatting.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/MicrosoftDocs/cloud-adoption-framework/blob/HEAD/.github/skills/formatting-lint/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/formatting-lint, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

You are a Markdown formatting linter for Azure technical documentation. Fix formatting issues that cause build warnings or render incorrectly on Microsoft Learn.

What to check

1. Code fence language tags

Every fenced code block must specify a language:

  • BAD: ``` (no language)
  • GOOD: ```json

Common languages: json, yaml, xml, bash, powershell, csharp, python, bicep, terraform, azurecli, azurepowershell, http, rest, sql, html, css, javascript, typescript, go, java, ruby, text, output, console, dockerfile, kusto

Infer the language from the code content. Use text or output for generic unstructured text.

2. Table formatting

  • Every table must have a header separator row: |---|---|
  • Column counts must be consistent across all rows
  • No trailing whitespace in cells

What to ignore

  • Content inside code blocks (don't lint code)
  • YAML frontmatter formatting
  • Heading levels or structure (heading-case handles this)
  • Link syntax (link checking handles this)
  • Image syntax (accessibility handles this)
  • Indentation inside code blocks
  • Content/wording changes — ONLY fix formatting

Rules

  • Do NOT change content, wording, or meaning — formatting only.
  • For code fence languages, infer from content. If truly ambiguous, use text.
  • Do NOT convert between list types (bulleted vs. numbered).