Logo: Relish

  1. Sign in

Project: relish

Render description as markdown

In order to make best use of the description field in Gherkin,

as a feature author

I want my descriptions to recognize markdown.

So for example, I would like to be able to include...

Sections of pre-formatted text 

  /~\
 C oo
 _( ^)
/   ~\

Like this cheeky monkey

As well as...

  • ...bulleted lists
  • although note that my lists must use the hyphen
  • and not the asterisk which Gherkin will think is a step

  1. one
  2. two

See more details on the Markdown homepage

Background
Given
a project "rspec/rspec-core"
Scenarios
Render a feature with markdown in the description of various keywords

Gherkin / Cucumber supports descriptions beneath each of the following keywords:

  • Feature:
  • Background:
  • Scenario:
  • Scenario Outline:
  • Examples:

Now relish supports them too, so go forth and beautify!

Given
a feature has been pushed to the "rspec-core" project:
Feature: Foo

  This is a *significant* word

  | This | Is    |
  | ---- | ------|
  | a    | table |

  Scenario: Bar
  
    This is **important** text
    
  Scenario Outline: Baz
  
    Here is a [link to relishapp](http://relishapp.com)
    and another link: www.relishapp.com
  
    Examples:
    
      This _message_ is important too.
    
When
I go to Foo's feature page
Then
I should see the text "significant" emphasized
And
I should see the text "table" in a table cell
And
I should see the text "important" in bold
And
I should see the text "link to relishapp" is a link to "http://relishapp.com"
And
I should see the text "www.relishapp.com" is a link to "http://www.relishapp.com"
And
I should see the text "message" emphasized

Last published almost 7 years ago by mattwynne.