Markdown Format
Documentsmarkdown-formatMarkdown 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.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/liferay/liferay-portal/blob/HEAD/.claude/skills/markdown-format/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/markdown-format, 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.
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).