https://github.com/pantheon-systems/validate-readme-spacing

An action to validate the header section of your WordPress plugin is spaced correctly
https://github.com/pantheon-systems/validate-readme-spacing

github-actions hacktoberfest readme readme-txt-validator wordpress

Last synced: about 1 year ago
JSON representation

An action to validate the header section of your WordPress plugin is spaced correctly

• Host: GitHub
• URL: https://github.com/pantheon-systems/validate-readme-spacing
• Owner: pantheon-systems
• License: mit
• Created: 2023-07-06T17:25:47.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-11T01:25:19.000Z (over 1 year ago)
• Last Synced: 2025-04-05T11:13:08.287Z (over 1 year ago)
• Topics: github-actions, hacktoberfest, readme, readme-txt-validator, wordpress
• Language: Shell
• Homepage:
• Size: 24.4 KB
• Stars: 2
• Watchers: 23
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.MD
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

          
# Validate Readme Spacing

[![Testing](https://github.com/pantheon-systems/validate-readme-spacing/actions/workflows/test.yml/badge.svg)](https://github.com/pantheon-systems/validate-readme-spacing/actions/workflows/test.yml) [![MIT License](https://img.shields.io/github/license/pantheon-systems/validate-readme-spacing)](https://github.com/pantheon-systems/validate-readme-spacing/blob/main/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 

``` yaml

uses: pantheon-systems/validate-readme-spacing@v1

with:

  filepath: 'README.md'

```