https://github.com/hukkin/mdformat-gfm

Mdformat plugin for GitHub Flavored Markdown compatibility
https://github.com/hukkin/mdformat-gfm

gfm github-flavored-markdown markdown markdown-table mdformat

Last synced: 7 months ago
JSON representation

Mdformat plugin for GitHub Flavored Markdown compatibility

• Host: GitHub
• URL: https://github.com/hukkin/mdformat-gfm
• Owner: hukkin
• License: mit
• Created: 2020-11-12T14:26:34.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2025-03-03T17:29:28.000Z (8 months ago)
• Last Synced: 2025-03-21T07:49:55.824Z (7 months ago)
• Topics: gfm, github-flavored-markdown, markdown, markdown-table, mdformat
• Language: Python
• Homepage:
• Size: 135 KB
• Stars: 15
• Watchers: 3
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status](https://github.com/hukkin/mdformat-gfm/actions/workflows/tests.yaml/badge.svg?branch=master)](https://github.com/hukkin/mdformat-gfm/actions?query=workflow%3ATests+branch%3Amaster+event%3Apush)

[![PyPI version](https://img.shields.io/pypi/v/mdformat-gfm)](https://pypi.org/project/mdformat-gfm)

# mdformat-gfm

> Mdformat plugin for GitHub Flavored Markdown compatibility

## Description

[Mdformat](https://github.com/executablebooks/mdformat) is a formatter for

[CommonMark](https://spec.commonmark.org/current/)

compliant Markdown.

Mdformat-gfm is an mdformat plugin that changes the target specification to

[GitHub Flavored Markdown (GFM)](https://github.github.com/gfm/),

making the tool able to format the following syntax extensions:

- [tables](https://github.github.com/gfm/#tables-extension-)

- [task list items](https://github.github.com/gfm/#task-list-items-extension-)

- [strikethroughs](https://github.github.com/gfm/#strikethrough-extension-)

- [autolinks](https://github.github.com/gfm/#autolinks-extension-)

- [disallowed raw HTML](https://github.github.com/gfm/#disallowed-raw-html-extension-)

  (note that no changes are required from a formatter to support this extension)

## Install

```sh

pipx install mdformat

pipx inject mdformat mdformat-gfm

```

## Usage

```sh

mdformat 

```