https://github.com/nadar/github-markdown-fixer

Fixing Github Markdown Files
https://github.com/nadar/github-markdown-fixer

fixer gfm github hacktoberfest markdown standards

Last synced: 29 days ago
JSON representation

Fixing Github Markdown Files

• Host: GitHub
• URL: https://github.com/nadar/github-markdown-fixer
• Owner: nadar
• Created: 2017-05-09T07:21:51.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-01-01T12:08:16.000Z (almost 7 years ago)
• Last Synced: 2024-10-12T01:18:55.252Z (about 1 month ago)
• Topics: fixer, gfm, github, hacktoberfest, markdown, standards
• Language: PHP
• Homepage: https://github.com/nadar
• Size: 365 KB
• Stars: 3
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# GitHub Markdown Fixer

[![LUYA](https://img.shields.io/badge/Powered%20by-LUYA-brightgreen.svg)](https://luya.io)

[![Total Downloads](https://poser.pugx.org/nadar/github-markdown-fixer/downloads)](https://packagist.org/packages/nadar/github-markdown-fixer)

[![Latest Stable Version](https://poser.pugx.org/nadar/github-markdown-fixer/v/stable)](https://packagist.org/packages/nadar/github-markdown-fixer)

This project fixes your Markdown files in order to render them nicely with GitHub and other Renderers.

Currently built in features:

+ Replace all tabs with 4 spaces.

+ Fixes none breaking spaces problem ([github/markup issue problem description](https://github.com/github/markup/issues/1054#issuecomment-300061967)).

![GitHub Markdown Fixer in Action](screenshot.png)

## Usage

Add the `nadar/github-markdown-fixer` to your project, within the `require-dev` section:

```sh

composer require nadar/github-markdown-fixer --dev

```

Go into your Terminal an run the Fixer:

```sh

./vendor/bin/gmf fix /folder

```

### Options

|argument|description

|--------|----------

|--dry     |run command in dry mode, does not change file contents, but display which files would change.