{"id":34029164,"url":"https://github.com/emiliogrv/mdformat-gherkin","last_synced_at":"2026-04-10T10:32:30.133Z","repository":{"id":323418347,"uuid":"1093035065","full_name":"emiliogrv/mdformat-gherkin","owner":"emiliogrv","description":"Mdformat plugin to beautify Gherkin code blocks","archived":false,"fork":false,"pushed_at":"2025-11-10T12:10:41.000Z","size":8,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-12-15T07:39:31.834Z","etag":null,"topics":["commonmark","gherkin","markdown","mdformat","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/emiliogrv.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-11-09T19:26:51.000Z","updated_at":"2025-11-10T02:20:57.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/emiliogrv/mdformat-gherkin","commit_stats":null,"previous_names":["emiliogrv/mdformat-gherkin"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/emiliogrv/mdformat-gherkin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emiliogrv%2Fmdformat-gherkin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emiliogrv%2Fmdformat-gherkin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emiliogrv%2Fmdformat-gherkin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emiliogrv%2Fmdformat-gherkin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/emiliogrv","download_url":"https://codeload.github.com/emiliogrv/mdformat-gherkin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emiliogrv%2Fmdformat-gherkin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31638460,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-10T07:40:12.752Z","status":"ssl_error","status_checked_at":"2026-04-10T07:40:11.664Z","response_time":98,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["commonmark","gherkin","markdown","mdformat","python"],"created_at":"2025-12-13T17:28:27.866Z","updated_at":"2026-04-10T10:32:30.122Z","avatar_url":"https://github.com/emiliogrv.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n[![License](https://img.shields.io/badge/license-BSD--3--Clause-green)](LICENSE)\n\n\u003c/div\u003e\n\n\u003c!-- mdformat-toc start --slug=github --maxlevel=6 --minlevel=1 --\u003e\n\n- [Features](#features)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Example](#example)\n- [Pre-commit Hook](#pre-commit-hook)\n- [License](#license)\n- [Acknowledgments](#acknowledgments)\n\n\u003c!-- mdformat-toc end --\u003e\n\n______________________________________________________________________\n\n## Features\u003ca name=\"features\"\u003e\u003c/a\u003e\n\n- Formats Gherkin feature files within markdown code blocks\n- Preserves all markdown formatting outside Gherkin code blocks\n- Supports all standard Gherkin keywords and syntax\n- Consistent formatting for better version control diffs\n- Seamless integration with pre-commit hooks\n\n## Installation\u003ca name=\"installation\"\u003e\u003c/a\u003e\n\n```bash\npip install mdformat-gherkin\n```\n\nYou may pin the reformat-gherkin dependency for formatting stability:\n\n```bash\npip install mdformat-gherkin reformat-gherkin==v3.0.1\n```\n\n## Usage\u003ca name=\"usage\"\u003e\u003c/a\u003e\n\nWhen using mdformat on the command line, Gherkin formatting will be automatically enabled after install.\n\nWhen using mdformat Python API, code formatting for Gherkin will have to be enabled explicitly:\n\n````python\nimport mdformat\n\nunformatted = \"\"\"```gherkin\nFeature: Test feature\n  Scenario: Test scenario\n    Given I have a test\n    When I run the test\n    Then it should pass\n```\"\"\"\n\nformatted = mdformat.text(unformatted, codeformatters={\"gherkin\"})\nprint(formatted)\n````\n\n## Example\u003ca name=\"example\"\u003e\u003c/a\u003e\n\nBefore formatting:\n\n````markdown\n```gherkin\nFeature: Test feature\nScenario: Test scenario\nGiven I have a test\nWhen I run the test\nThen it should pass\n```\n````\n\nAfter formatting with `mdformat-gherkin`:\n\n````markdown\n```gherkin\nFeature: Test feature\n\n  Scenario: Test scenario\n    Given I have a test\n    When I run the test\n    Then it should pass\n```\n````\n\n## Pre-commit Hook\u003ca name=\"pre-commit-hook\"\u003e\u003c/a\u003e\n\nYou can use this plugin with [pre-commit](https://pre-commit.com/). Add the following to your `.pre-commit-config.yaml`:\n\n```yaml\n  - repo: https://github.com/executablebooks/mdformat\n    rev: 1.0.0  # Use the latest version\n    hooks:\n      - id: mdformat\n        additional_dependencies:\n          - mdformat-gherkin\n        # Optional: pin specific versions\n        # - reformat-gherkin==v3.0.1\n```\n\n## License\u003ca name=\"license\"\u003e\u003c/a\u003e\n\nThis project is licensed under the BSD 3-Clause License - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\u003ca name=\"acknowledgments\"\u003e\u003c/a\u003e\n\nThis project is based on the work of [reformat-gherkin](https://github.com/ducminh-phan/reformat-gherkin).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femiliogrv%2Fmdformat-gherkin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Femiliogrv%2Fmdformat-gherkin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femiliogrv%2Fmdformat-gherkin/lists"}