Skip to main content

Markdown

Markdown is a way to style text on the web. You control the display of the document; formatting words as bold or italic, adding images, and creating lists are just a few of the things we can do with Markdown. Mostly, Markdown is just regular text with a few non-alphabetic characters thrown in, like # or *.

Syntax guide​

Here’s an overview of Markdown syntax that you can use.

Headers​

This is an <h1> tag

This is an <h2> tag​

This is an <h6> tag​

Emphasis​

This text will be italic This will also be italic This text will be bold This will also be bold You can combine them

Lists​

Unordered​

  • Item 1
  • Item 2
    • Item 2a
    • Item 2b

Ordered​

  1. Item 1
  2. Item 2
  3. Item 3
    1. Item 3a
    2. Item 3b

Images​

GitHub Logo Format: ![Alt Text](url)

https://github.com - automatic! GitHub

Blockquotes​

As Kanye West said:

We're living the future so the present is our past.

Inline code​

I think you should use an <addr> element here instead.

Syntax highlighting​

Here’s an example of how you can use syntax highlighting with GitHub Flavored Markdown:

function fancyAlert(arg) {
  if(arg) {
    $.facebox({div:'#foo'})
  }
}

You can also simply indent your code by four spaces:

function fancyAlert(arg) {
  if(arg) {
    $.facebox({div:'#foo'})
  }
}

Here’s an example of Python code without syntax highlighting:

def foo():
    if not bar:
        return True

Task lists​

  • @mentions, #refs, links, formatting, and tags supported
  • list syntax required (any unordered or ordered list supported)
  • this is a complete item
  • this is an incomplete item

If you include a task list in the first comment of an Issue, you will get a handy progress indicator in your issue list. It also works in Pull Requests!

Tables​

You can create tables by assembling a list of words and dividing them with hyphens - (for the first row), and then separating each column with a pipe |:

First HeaderSecond Header
Content from cell 1Content from cell 2
Content in the first columnContent in the second column

Datagrok-specific markup​

A powerful mechanism that allows to embed platform-specific visual elements right into the HTML document. Simply embed the expression like that: #{expression}, see more information there.

See also: