# Markdown Format

> Markdown Format is an Agent Skill for documents published in the liferay/liferay-portal repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Format a Markdown file to match Liferay conventions — frontmatter order, Title Case headings, braced shell variables, long-form CLI flags, and professional prose. Use when the user asks to format, clean up, polish, or copy-edit a Markdown file destined for the Liferay repository.

- Skill name: `markdown-format`
- Category: [Documents](https://www.openparable.com/skill/documents/1)
- Source: https://github.com/liferay/liferay-portal/blob/HEAD/.claude/skills/markdown-format/SKILL.md
- Repository: liferay/liferay-portal (2,259 GitHub stars when collected)

## SKILL.md

# Markdown Formatter

Apply Liferay Markdown conventions to the target file so its structure, casing, and prose are consistent and professional.

## Input

When `${ARGUMENTS}` is a path to a Markdown file, format that file. When no path is supplied, ask the user which file to format.

## Workflow

### Read the File

Read the target file in full before making changes. Note the frontmatter, headings, code blocks, and any conventions already in use.

### Apply the Conventions

Apply all conventions defined in `.claude/rules/markdown-style.md`. Work through each category in order. Fix each category before moving to the next.

### Validate

Reread the file after the pass and confirm every check still holds.

### Report

Summarize the changes, grouped by category (frontmatter, headings, prose, shell, lists).

---

Source: https://www.openparable.com/skill/documents/markdown-format (OpenParable). Cite the canonical URL above.