Flowdock

Markup help

The same Markup engine, SimpleMarkup, is used to parse notes as is used to parse documentation to HTML in RDoc. Markup can be written fairly naturally and it is similar to Wiki markup. Below we have described the most common use cases, but if you want to learn more, you can look at official SimpleMarkup documentation.

We recommend that you follow docrails conventions as much as applicable.

Headings are entered using equals signs.

= Level One Heading
== Level Two Heading
=== Level Three Heading 
    

This will render as:

Level One Heading

Level Two Heading

Level Three Heading

Lists are typed as indented paragraphs with a '*' or '-' (for bullet lists) a digit followed by a period for numbered lists.

* List item 1
* List item 2
 1. Numbered list item 1
 1. Numbered list item 2
* List item 3
    

This will render as:

  • List item 1
  • List item 2
    1. Numbered list item 1
    2. Numbered list item 2
  • List item 3

Non-verbatim text can be marked up.

_italic_ or <em>italic</em>, 
*bold* or <b>bold</b>, 
+typewriter+ or <tt>typewriter</tt>
    

This will render as:

italic or italic, bold or bold, typewriter or typewriter

URLs and links to method and class names are recognized automatically.

An action may contain only a single render or a single redirect. 
Attempting to try to do either again will result in a DoubleRenderError. 

http://apidock.com

    

This will render as:

An action may contain only a single render or a single redirect. Attempting to try to do either again will result in a DoubleRenderError.

http://apidock.com

Rules (horizontal lines) are entered using three or more hyphens.

Text
---
Foo
    

This will render as:

Text
Foo

Code examples are typed as lines indented with two spaces.

==== Code example   

  def do_something
    redirect_to :action => "elsewhere"
    render :action => "overthere" # raises DoubleRenderError
  end
    

This will render as:

Code example

def do_something
  redirect_to :action => "elsewhere"
  render :action => "overthere" # raises DoubleRenderError
end