Skip to content

WordPress Plugin README.md Validator

Actions
Checks a README.md file that uses the standard WordPress readme.txt plugin header format for valid markdown
v1.0.5
Latest
Star (2)

Validate Readme Spacing

Testing MIT License

A GitHub Action that validates that the heading section of your plugin's README.md has newlines handled correctly.

When writing markdown, two spaces are required at the end of a line to preserve single line breaks in the rendered view. Some people's (@jazzsequence) IDEs helpfully remove these and the diff can be missed in GitHub's PR view.

Input

filepath

The path to the project's README file. Defaults to README.md.

Example Usage

uses: pantheon-systems/validate-readme-spacing@v1
with:
  filepath: 'README.md'

WordPress Plugin README.md Validator is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Checks a README.md file that uses the standard WordPress readme.txt plugin header format for valid markdown
v1.0.5
Latest

WordPress Plugin README.md Validator is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.