mdformat-gfm


Namemdformat-gfm JSON
Version 0.3.5 PyPI version JSON
download
home_pagehttps://github.com/hukkinj1/mdformat-gfm
SummaryMdformat plugin for GitHub Flavored Markdown compatibility
upload_time2021-12-04 01:10:07
maintainer
docs_urlNone
authorTaneli Hukkinen
requires_python>=3.7,<4.0
licenseMIT
keywords mdformat markdown formatter gfm
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![Build Status](https://github.com/hukkinj1/mdformat-gfm/workflows/Tests/badge.svg?branch=master)](https://github.com/hukkinj1/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
pip install mdformat-gfm
```

## Usage

```sh
mdformat <filename>
```


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/hukkinj1/mdformat-gfm",
    "name": "mdformat-gfm",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7,<4.0",
    "maintainer_email": "",
    "keywords": "mdformat,markdown,formatter,gfm",
    "author": "Taneli Hukkinen",
    "author_email": "hukkinj1@users.noreply.github.com",
    "download_url": "https://files.pythonhosted.org/packages/5e/31/1ac2f7f7a16ef33b4de03c9296afe18659624d67886da802a871c85eef31/mdformat-gfm-0.3.5.tar.gz",
    "platform": "",
    "description": "[![Build Status](https://github.com/hukkinj1/mdformat-gfm/workflows/Tests/badge.svg?branch=master)](https://github.com/hukkinj1/mdformat-gfm/actions?query=workflow%3ATests+branch%3Amaster+event%3Apush)\n[![PyPI version](https://img.shields.io/pypi/v/mdformat-gfm)](https://pypi.org/project/mdformat-gfm)\n\n# mdformat-gfm\n\n> Mdformat plugin for GitHub Flavored Markdown compatibility\n\n## Description\n\n[Mdformat](https://github.com/executablebooks/mdformat) is a formatter for\n[CommonMark](https://spec.commonmark.org/current/)\ncompliant Markdown.\n\nMdformat-gfm is an mdformat plugin that changes the target specification to\n[GitHub Flavored Markdown (GFM)](https://github.github.com/gfm/),\nmaking the tool able to format the following syntax extensions:\n\n- [tables](https://github.github.com/gfm/#tables-extension-)\n- [task list items](https://github.github.com/gfm/#task-list-items-extension-)\n- [strikethroughs](https://github.github.com/gfm/#strikethrough-extension-)\n- [autolinks](https://github.github.com/gfm/#autolinks-extension-)\n- [disallowed raw HTML](https://github.github.com/gfm/#disallowed-raw-html-extension-)\n  (note that no changes are required from a formatter to support this extension)\n\n## Install\n\n```sh\npip install mdformat-gfm\n```\n\n## Usage\n\n```sh\nmdformat <filename>\n```\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Mdformat plugin for GitHub Flavored Markdown compatibility",
    "version": "0.3.5",
    "project_urls": {
        "Homepage": "https://github.com/hukkinj1/mdformat-gfm",
        "Repository": "https://github.com/hukkinj1/mdformat-gfm"
    },
    "split_keywords": [
        "mdformat",
        "markdown",
        "formatter",
        "gfm"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d443c05257ba93ef5b1ed9b6c4b4225efb8cb3000b7fc8364469457fac817e2e",
                "md5": "79f27bd3e7e793107d9db543e716cd6a",
                "sha256": "1e627edc7665b59e008b3b9e5decc18c40cbd625c196d77e5ea3bc624e80ac8a"
            },
            "downloads": -1,
            "filename": "mdformat_gfm-0.3.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "79f27bd3e7e793107d9db543e716cd6a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7,<4.0",
            "size": 4904,
            "upload_time": "2021-12-04T01:10:06",
            "upload_time_iso_8601": "2021-12-04T01:10:06.950954Z",
            "url": "https://files.pythonhosted.org/packages/d4/43/c05257ba93ef5b1ed9b6c4b4225efb8cb3000b7fc8364469457fac817e2e/mdformat_gfm-0.3.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5e311ac2f7f7a16ef33b4de03c9296afe18659624d67886da802a871c85eef31",
                "md5": "f441db43d4a43e31cc6fc9993b4ad703",
                "sha256": "5ee5f0de1d3b56d5edfced023bfff0aeed958be328e5460dac3221ac1b61ce7c"
            },
            "downloads": -1,
            "filename": "mdformat-gfm-0.3.5.tar.gz",
            "has_sig": false,
            "md5_digest": "f441db43d4a43e31cc6fc9993b4ad703",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7,<4.0",
            "size": 4578,
            "upload_time": "2021-12-04T01:10:07",
            "upload_time_iso_8601": "2021-12-04T01:10:07.769928Z",
            "url": "https://files.pythonhosted.org/packages/5e/31/1ac2f7f7a16ef33b4de03c9296afe18659624d67886da802a871c85eef31/mdformat-gfm-0.3.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-12-04 01:10:07",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "hukkinj1",
    "github_project": "mdformat-gfm",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mdformat-gfm"
}
        
Elapsed time: 0.06860s