Skip to main content

Markdown Guide

Learn how to use Markdown here.

Written by Maahi Islam
Updated over 3 weeks ago

TutorCruncher allows text formatting using the markup language Markdown in multiple areas of the system. You can format plain text efficiently with very simple code in Job descriptions, emails, Broadcasts, Reports, etc.

To apply formatting to plain text you can either use the tools provided on top of the text field or write the text with Markdown straight away. To preview how the text will be rendered click on the eye symbol.

Markdown editor in TutorCruncher

Markdown editor in TutorCruncher.

Headers

Header

Code

Result

Heading 1

# H1

H1

Heading 2

## H2

H2

Heading 3

### H3

H3

Heading 4

#### H4

H4

Heading 5

##### H5

H5

Heading 6

###### H6

H6

Emphasis

Effect

Code

Result

Italic

*Italic*

Italic

Bold

**Bold**

Bold

Bold and Italic

**_Bold and Italic_**

Bold and Italic

Lists

1. For ordered lists 1. give the list item 1. A number 1. Sublists use 1. indents of four spaces.
  1. For ordered lists

  2. give the list item

  3. A number
    1. Sublists use
    2. indents of four spaces.

* Unordered lists * use asterisks * and spaces. * Sublists use * indents of four spaces.
  • Unordered lists

  • use asterisks

  • and spaces.
    * Sublists use
    * indents of four spaces.

Links

Links can easily be created like this [TutorCruncher](https://tutorcruncher.com) and will render like this: TutorCruncher.

You can add a link title that displays when you hover over the link like this:

[Check out our website.](https://tutorcruncher.com "TutorCruncher")

Images

Images can be inserted like this

![TutorCruncher](https://secure.tutorcruncher.com/static/tc-box-logo.png)
TutorCruncher

You can put an alt text that displays when you hover over the image in the brackets like this ![alt text], or leave them blank ![].

Images as a link

It's simply a combination of the above two options:

[![TutorCruncher](https://secure.tutorcruncher.com/static/tc-box-logo.png)](https://tutorcruncher.com)
TutorCruncher

Tables

Tables can also be created in Markdown and used in text boxes in TutorCruncher.

| This is | a table | in Markdown |

|--------------|:--------------:|--------------:|

| columns | can be aligned | with colons |

| left aligned | centered | right aligned |

| **Markdown** | *also renders* | in tables |

This is

a table

in Markdown

columns

can be aligned

with colons

left aligned

centered

right aligned

Markdown

also renders

in tables

Colons can be used in the second row of the table to align the columns. It is not necessary to line up the raw Markdown for it to render properly as long as there are at least three dashes separating each header cell.

not | aligned | still | works

--- | --- | --- | ---

1 | 2 | 3 | 4

not

aligned

still

works

1

2

3

4

Attaching documents/PDFs/pictures/images to a Broadcast/email

You can upload files such as images, PDFs, etc. that can be linked to or used in emails. You do this by uploading a publicly viewable file, meaning that anybody with the link will be able to access the file.

List of publicly available files.

List of publicly available files.

  1. Navigate to Communications > Public Files, choose your file from your computer, and click 'Upload'. The file will appear in the list on the page.

  2. Click on the 'Copy to clipboard' icon, next to the file name, to copy the files link to your clipboard ready to be pasted.

  3. Add this link address with the Markdown editor (email body) for Email Definitions and Broadcasts or the HTML editor for templates.


​

Did this answer your question?