Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/raviqqe/gherkin2markdown
Gherkin to Markdown converter
https://github.com/raviqqe/gherkin2markdown
cucumber gherkin markdown
Last synced: 2 months ago
JSON representation
Gherkin to Markdown converter
- Host: GitHub
- URL: https://github.com/raviqqe/gherkin2markdown
- Owner: raviqqe
- License: mit
- Created: 2018-06-19T05:17:03.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-11-25T13:37:12.000Z (3 months ago)
- Last Synced: 2024-11-26T01:31:56.729Z (3 months ago)
- Topics: cucumber, gherkin, markdown
- Language: Go
- Homepage:
- Size: 85.9 KB
- Stars: 28
- Watchers: 5
- Forks: 21
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ccamel - raviqqe/gherkin2markdown - Gherkin to Markdown converter (Go)
README
# gherkin2markdown
[](https://github.com/raviqqe/gherkin2markdown/actions)
[](https://codecov.io/gh/raviqqe/gherkin2markdown)
[](https://goreportcard.com/report/github.com/raviqqe/gherkin2markdown)
[](LICENSE)A command to convert Gherkin files into Markdown.
## Installation
```
go install github.com/raviqqe/gherkin2markdown@latest
```## Usage
```
gherkin2markdown
```or
```
gherkin2markdown
```## Example
_Given_ a file named `math.feature` with:
```gherkin
Feature: Python
Scenario: Hello, world!
Given a file named "main.py" with:
"""python
print("Hello, world!")
"""
When I successfully run `python3 main.py`
Then the stdout should contain exactly "Hello, world!"Scenario Outline: Add numbers
Given a file named "main.py" with:
"""python
print( + )
"""
When I successfully run `python3 main.py`
Then the stdout should contain exactly ""Examples:
| x | y | z |
| 1 | 2 | 3 |
| 4 | 5 | 9 |
```_When_ I successfully run `gherkin2markdown math.feature`
_Then_ the stdout should contain exactly:
````markdown
# Python## Hello, world!
_Given_ a file named "main.py" with:
```python
print("Hello, world!")
```_When_ I successfully run `python3 main.py`
_Then_ the stdout should contain exactly "Hello, world!".
## Add numbers
_Given_ a file named "main.py" with:
```python
print( + )
```_When_ I successfully run `python3 main.py`
_Then_ the stdout should contain exactly "\".
### Examples
| x | y | z |
| --- | --- | --- |
| 1 | 2 | 3 |
| 4 | 5 | 9 |
````## License
[MIT](LICENSE)