Skip to content
Back to skills

Markdown Format

ASecurity

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.

  • 2,266 stars
  • 0 votes
  • 0 copies
  • 2 views
  • Added August 31, 2026
toolsgoshellbash

Works with

  • cli

Security analysis

A100/100

Scanned August 31, 2026

npx -y skills add liferay/liferay-portal --skill markdown-format --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Markdown Format?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Markdown Format
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/liferay-markdown-format/badge)](https://www.skillsdirectory.com/skills/liferay-markdown-format)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---

allowed-tools: [Bash, Edit, Glob, Grep, Read, Write]
argument-hint: "[path to Markdown file]"
description: 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.
name: markdown-format

---

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

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…

Newsletter

Get the weekly list of safe new skills, and the ones we pulled.