Description Markdown Field

  • Sep 10, 2013

What is the description field for?

Use this area to set the stage for the kata. Describe what the problem is and what the user needs to do to begin to solve it.

You can use markdown within the description field to describe your kata. For example you can link to external web links, use bullet points or section headings. Perhaps the most useful markdown feature is the ability to embed code within your description. Simply wrap your code block within three back ticks (```) both before and after the code. After the opening set of back ticks you can specify the language.

For example - to embed javascript:

```javascript
var a = 1;
```

If you are creating a kata with multiple languages than you can specify examples for multiple languages back-to-back. Only the relevant language will be displayed within the rendered output. If you place any text between the code blocks then they will not be grouped. For example:

These examples will be grouped

```javascript
var a = 1;
```
```coffeescript
a = 1;
```

These will not be grouped

```javascript
var a = 1;
```

CoffeeScript:
```coffeescript
a = 1;
```

Tips

Some kata descriptions will be pretty long, especially if you are describing an algorithm that needs to be coded from scratch. Others may end up being very short. Sometimes its easier to put notes within the initial code that the user will see instead of describing things within the description.

Discuss:

Loading comments...