Markdown Syntax Reference


Markdown is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML).

Dataset summaries and discussions on use the Markdown format. This means that users can create beautiful documentation with simple markup that's easy to write and read.

This document will show you how to take advantage of Markdown to format your summary and discussion posts.

Phrase Emphasis

*italic*   **bold**
_italic_   __bold__


An [example]( "Title")

Reference style labels (titles are optional):

An [example][id]. Then, anywhere
else in the doc, define the link:

   [id]:  "Title"


Todo lists are much like normal lists, but will be rendered with checkboxes instead of bullets.

* [ ] This is an unchecked TODO item
* [x] This is a completed TODO item


Inline (title is optional):

![alt text](/path/img.jpg "Title")

Reference style:

![alt text][id]

    [id]: /url/to/img.jpg "Title"


The following formats can all be used interchangeably for headers.

Header 1

Header 2

# Header 1 #

## Header 2 ##

# Header 1

## Header 2


Ordered, without paragraphs:

1.  Foo
2.  Bar

Unordered, with paragraphs:

*   A list item.
    With multiple paragraphs.
*   Bar

You can nest them:

*   An unordered list item
    * A nested unordered list item
*   Another list item
    1.  The first nested ordered list item
    2.  A second nested ordered list item
        * A nested unordered list
    3. This is the last nested ordered list item
*   The last unordered list item


> Email-style angle brackets
> are used for blockquotes.
> > And, they can be nested.
> >
> * You can quote a list.
> * Etc.

Code Spans

`<code>` spans are delimited
by backticks.
You can include literal backticks
like `` `this` ``.

Pre-formatted Code Blocks

Indent every line of a code block by at least 4 spaces or 1 tab, and use a colon at the end of the preceding paragraph.

This is a normal paragraph:

    This is a preformatted
    code block.
Preceded by a space, the colon disappears. :

    This is a preformatted
    code block.

Wrapping code in three back-ticks will also format code blocks :

Code goes here

Horizontal Rules

Three or more dashes or asterisks:

* * *
- - - -

Manual Line Breaks

End a line with two or more spaces:

Roses are red,••
Violets are blue.

(where • is a space)


|Column 1|Column 2|
|value 11|value 21|
|value 12|value 22|
|value 13|value 23|

Embedding / Inline Previews

Embedding content is simple. Just include a link to the site on it's own line and we'll attempt to expand an inline preview of the content.

Note: links with this format will only be previewed if
they appear on their own line.

Supported Types

  • Tableau
  • Youtube
  • Vimeo
  • Facebook
  • Twitter
  • etc.

Vega and Vega-Lite

Vega and Vega-Lite are visualization grammars built on top of D3. See Vega-Lite and Vega for more information on how to build your own custom visualizations.

Check out the Vega editor for some examples of what's possible.

NOTE: currently only supports Vega version 3 and Vega-Lite version 2 (we do not support older versions)

If your visualization is hosted on (uploaded to a dataset), you may reference it directly in markdown.


Inline Code

If you want to embed your visualization direction within a summary or comment, use the following format.

  "$schema": "",
  "description": "A simple bar chart with embedded data. An example vega-lite file.",
  "width": 360,
  "data": {
    "values": [
      {"a": "A","b": 28}, {"a": "B","b": 55}, {"a": "C","b": 43},
      {"a": "D","b": 91}, {"a": "E","b": 81}, {"a": "F","b": 53},
      {"a": "G","b": 19}, {"a": "H","b": 87}, {"a": "I","b": 52}
  "mark": "bar",
  "encoding": {
    "x": {"field": "a", "type": "ordinal"},
    "y": {"field": "b", "type": "quantitative"}
  /* ... raw vega definition ... */

Note: Vega and Vega-Lite will only render in This markdown will render as a code block in other sites

Math Formulas (MathJax)

When $a \ne 0$, there are two solutions to \\(ax^2 + bx + c = 0\\) and they are

$$x = {-b \pm \sqrt{b^2-4ac} \over 2a}.$$

See MathJax Homepage for more information.

results matching ""

    No results matching ""