Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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: 4 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 (over 4 years ago)
Default Branch: master
Last Pushed: 2024-10-27T13:38:35.000Z (4 months ago)
Last Synced: 2024-10-27T15:14:59.093Z (4 months ago)
Topics: gfm, github-flavored-markdown, markdown, markdown-table, mdformat
Language: Python
Homepage:
Size: 137 KB
Stars: 13
Watchers: 4
Forks: 2
Open Issues: 2
Metadata Files:
- Readme: README.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 

```