Skip to main content

Story details formatting options using Markdown

Simple formatting in story details

Written by Tamás Párványik

Contents:

What is markdown?


Markdown formatting is a simple but powerful way to make your story details more expressive. Some simple formatting options are also available for story card titles. Most of the markdown options have more alternatives.
​
​

Formatting options:

You can use the following formatting options for text content:
​

Headings:

# Heading1
## Heading2
### Heading3

Alternative H1
==============

Alternative H2
--------------

Emphasis:

*Italics*
_Italics_

Italics
​Italics

**Bold**
__Bold__

Bold
​Bold
​

Strikethrough:

~~Mistaken text~~

Block-quote:

> This is a blockquote with two paragraphs.
>
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit.

Nested block-quote:

> This is the first level of quoting.
>
> > This is nested block-quote.
>
> Back to the first level.

Unordered list:

* Red
* Green
* Blue

- Red
- Green
- Blue

+ Red
+ Green
+ Blue

Ordered list:

1. Bird
    1. Parakeet
    1. Parrot
    1. Chicken
1. Dog
1. Cat

Definition list:

Term 1
: Definition 1

Term 2
: This definition has a code block.

        code block

Footnotes:

Here is a footnote[^footnote].

  [^footnote]: Here is the *text* of the **footnote**.

Code:

Inline `code` has `back-ticks around` it.

Fenced code block:

Note:
You can add an optional language identifier to enable syntax highlighting in your fenced code block.

For example, to syntax highlight Ruby code:

'''ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
'''

In case you like to use code blocks only to highlight something or to have nested list items please use:

'''text

Lorem ipsum...

'''

Horizontal line:

***

Link:

Visit [StoriesOnBoard](http://www.storiesonboard.com)
http://www.storiesonboard.com

Images:

  • Simple:

![Mockup1](http://www.flexdevelopers.com/b/uploaded_images/mytube.gif)
  • With title:

![Alt text](http://www.flexdevelopers.com/b/uploaded_images/mytube.gif "Optional title")
  • Referenced:

![Alt text][id]

[id]: http://www.flexdevelopers.com/b/uploaded_images/mytube.gif  "Optional title attribute"

You can get markup for the images attached to the cards by hovering over the image and clicking on "get markup".

Tables:

Right-aligned Value, centered Qty

| Item     | Value | Qty  |
| -------- | -----:|:---: |
| Computer | $1600 | 5    |
| Phone    | $12   | 12   |
| Pipe     | $1    | 234  |
Did this answer your question?