Skip to content

docs: audit and fix missing language tags in markdown code blocks#6790

Open
vanshika2720 wants to merge 2 commits into
pipe-cd:masterfrom
vanshika2720:fix/missing-syntax-highlighting
Open

docs: audit and fix missing language tags in markdown code blocks#6790
vanshika2720 wants to merge 2 commits into
pipe-cd:masterfrom
vanshika2720:fix/missing-syntax-highlighting

Conversation

@vanshika2720
Copy link
Copy Markdown

@vanshika2720 vanshika2720 commented May 18, 2026

What this PR does:
Audits all active (non-versioned) documentation markdown files under docs/content/en/ and adds the appropriate language syntax highlighting tags (bash, yaml, hcl, terraform, console, text) to all code blocks that previously used plain untagged backticks (```).

Specifically, this PR fixes 28 code blocks across 9 active documentation files:

  • control-plane-on-ecs.md (HCL/Terraform, YAML configs, bash commands)
  • pipecd-at-kubecon-eu-2024.md / pipecd-at-kubecon-hongkong-2024.md (Plain text schedule metadata)
  • metrics.md (Port forwarding and Helm CLI commands)
  • command-line-tool.md (pipectl CLI examples)
  • script-run.md (YAML snippets and folder structure text)
  • auth.md (Access policies text)
  • runtime-options.md (CLI help console output)
  • contributing.md (Commit message examples)

Why we need it:
Without specifying language tags, code blocks render as unstyled plain text on the generated documentation site. Adding appropriate syntax tags enhances readability, visually structures the commands, and provides a polished developer experience for users reading the documentation.

Does this PR introduce a user-facing change?:

  • How are users affected by this change: The code blocks in the documentation on the PipeCD website will now render with proper syntax highlighting.
  • Is this breaking change: No
  • How to migrate (if breaking change): N/A

Signed-off-by: Vanshika <pahalvanshikaa@gmail.com>
@vanshika2720 vanshika2720 force-pushed the fix/missing-syntax-highlighting branch from 4bd7cf6 to d68c835 Compare May 18, 2026 17:24
@vanshika2720
Copy link
Copy Markdown
Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant