Skip to content
Gherkin to Markdown converter
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
.gitignore
LICENSE
README.md
arguments.go
arguments_test.go
convert.go
convert_test.go
main.go
main_test.go
renderer.go
renderer_test.go

README.md

gherkin2markdown

Circle CI Codecov Go Report Card License

A command to convert Gherkin files into Markdown.

Installation

go get -u github.com/raviqqe/gherkin2markdown

Usage

gherkin2markdown <file>

or

gherkin2markdown <srcdir> <destdir>

Example

Given a file named math.feature with:

Feature: Python
  Scenario: Hello, world!
    Given a file named "main.py" with:
    """
    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:
    """
    print(<x> + <y>)
    """
    When I successfully run `python3 main.py`
    Then the stdout should contain exactly "<z>"
    Examples:
      | x | y | z |
      | 1 | 2 | 3 |
      | 4 | 5 | 9 |

When I successfully run gherkin2markdown math.feature

Then the stdout should contain exactly:

# Python

## Hello, world!

_Given_ a file named "main.py" with:

```
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:

```
print(<x> + <y>)
```

_When_ I successfully run `python3 main.py`

_Then_ the stdout should contain exactly "<z>".

### Examples

| x | y | z |
|---|---|---|
| 1 | 2 | 3 |
| 4 | 5 | 9 |

License

MIT

You can’t perform that action at this time.