---
name: Markdown Formatting
slug: markdown-formatter
category: Writing
description: Formats Markdown files to follow Liferay’s documentation conventions, including frontmatter structure, title case headings, shell variable syntax, and CLI flag style. Ideal for preparing or polishing Markdown content for the Liferay project.
github: "https://github.com/liferay/liferay-portal/tree/master/.claude/skills/markdown-format"
language: Java
stars: 2260
forks: 3789
install: "git clone https://github.com/liferay/liferay-portal"
added: 2026-07-20T06:48:17.306Z
last_synced: 2026-07-29T06:36:53.246Z
canonical_url: "https://dirskills.com/skills/markdown-formatter"
---

# Markdown Formatting

Formats Markdown files to follow Liferay’s documentation conventions, including frontmatter structure, title case headings, shell variable syntax, and CLI flag style. Ideal for preparing or polishing Markdown content for the Liferay project.

**Install:** `git clone https://github.com/liferay/liferay-portal`

## README

# 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).