| Name | mdformat-gfm JSON |
| Version |
0.4.1
JSON |
| download |
| home_page | None |
| Summary | Mdformat plugin for GitHub Flavored Markdown compatibility |
| upload_time | 2024-12-13 09:21:27 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
mdformat
markdown
formatter
gfm
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://github.com/hukkin/mdformat-gfm/actions?query=workflow%3ATests+branch%3Amaster+event%3Apush)
[](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 <filename>
```
Raw data
{
"_id": null,
"home_page": null,
"name": "mdformat-gfm",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "mdformat, markdown, formatter, gfm",
"author": null,
"author_email": "Taneli Hukkinen <hukkin@users.noreply.github.com>",
"download_url": "https://files.pythonhosted.org/packages/e5/db/873bad63b36e390a33bc0cf7222442010997d3ccf29a1889f24d28fdeddd/mdformat_gfm-0.4.1.tar.gz",
"platform": null,
"description": "[](https://github.com/hukkin/mdformat-gfm/actions?query=workflow%3ATests+branch%3Amaster+event%3Apush)\n[](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\npipx install mdformat\npipx inject mdformat mdformat-gfm\n```\n\n## Usage\n\n```sh\nmdformat <filename>\n```\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Mdformat plugin for GitHub Flavored Markdown compatibility",
"version": "0.4.1",
"project_urls": {
"Changelog": "https://github.com/hukkin/mdformat-gfm/blob/master/CHANGELOG.md",
"Homepage": "https://github.com/hukkin/mdformat-gfm"
},
"split_keywords": [
"mdformat",
" markdown",
" formatter",
" gfm"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "09ba3d4c680a2582593b8ba568ab60b119d93542fa39d757d65aae3c4f357e29",
"md5": "9ae9ec1f64ab051dc5fc16ed61d0915d",
"sha256": "63c92cfa5102f55779d4e04b16a79a6a5171e658c6c479175c0955fb4ca78dde"
},
"downloads": -1,
"filename": "mdformat_gfm-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9ae9ec1f64ab051dc5fc16ed61d0915d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 8750,
"upload_time": "2024-12-13T09:21:25",
"upload_time_iso_8601": "2024-12-13T09:21:25.158650Z",
"url": "https://files.pythonhosted.org/packages/09/ba/3d4c680a2582593b8ba568ab60b119d93542fa39d757d65aae3c4f357e29/mdformat_gfm-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e5db873bad63b36e390a33bc0cf7222442010997d3ccf29a1889f24d28fdeddd",
"md5": "b6218a79d40edc870d2e241426bbfc6b",
"sha256": "e189e728e50cfb15746abc6b3178ca0e2bebbb7a8d3d98fbc9e24bc1a4c65564"
},
"downloads": -1,
"filename": "mdformat_gfm-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "b6218a79d40edc870d2e241426bbfc6b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 7528,
"upload_time": "2024-12-13T09:21:27",
"upload_time_iso_8601": "2024-12-13T09:21:27.212866Z",
"url": "https://files.pythonhosted.org/packages/e5/db/873bad63b36e390a33bc0cf7222442010997d3ccf29a1889f24d28fdeddd/mdformat_gfm-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-13 09:21:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hukkin",
"github_project": "mdformat-gfm",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mdformat-gfm"
}
