Markdown in Rubrics and Assessments

What is Markdown?

Markdown is way to write plain text and have it rendered with all the richness of a word processor. Since Roobrick is a web application, the text is converted to HTML.

For example, in markdown you can write "this is **bold**" so that it appears as "this is bold". Of course, this is just a simple example, you can really go to town with markdown by creating content with lists, tables, links, quotes, code blocks and many other kinds of formats.

Roobrick's Markdown Support

Roobrick supports markdown in two main ways:

Rubric descriptions: It is important to provide background information to explain each rubric. The rubric description supports markdown so that the rubric can be clearly explained.
Assessment notes and annotations: Assessment scores should be explained clearly. Markdown support in assessments provides this capability.

Markdown Syntax

This section explains how to write markdown to explain your thoughts clearly:

Content type Markdown Result

Headings

# h1 Heading
## h2 Heading
### h3 Heading
#### h4 Heading
##### h5 Heading
###### h6 Heading

h1 Heading

h2 Heading

h3 Heading

h4 Heading

h5 Heading

h6 Heading

Emphasis

**This is bold text**
__This is bold text__
*This is italic text*
_This is italic text_
~~Deleted text~~

This is bold text
This is bold text
This is italic text
This is italic text
~~Deleted text~~

Lists

Unordered lists

+ Create a list by starting a line with `+`, `-`, or `*`
+ Sub-lists are made by indenting 2 spaces:
  - Marker character change forces new list start:
    * Ac tristique libero volutpat at
    + Facilisis in pretium nisl aliquet
    - Nulla volutpat aliquam velit
+ Very easy!

Ordered lists

1. Lorem ipsum dolor sit amet
2. Consectetur adipiscing elit
3. Integer molestie lorem at massa

1. You can use sequential numbers...
1. ...or keep all the numbers as `1.`

Start numbering with offset:

57. foo
1. bar

Unordered lists

Create a list by starting a line with +, -, or *
Sub-lists are made by indenting 2 spaces:
- Marker character change forces new list start:
  - Ac tristique libero volutpat at
  - Facilisis in pretium nisl aliquet
  - Nulla volutpat aliquam velit
Very easy!

Ordered lists

Lorem ipsum dolor sit amet
Consectetur adipiscing elit
Integer molestie lorem at massa
You can use sequential numbers...
...or keep all the numbers as 1.

Start numbering with offset:

Code

Inline `code`

Indented code

    // Some comments
    line 1 of code
    line 2 of code
    line 3 of code

Block code "fences"

```
var foo = function (bar) {
  return bar++;
};
```

Inline code

Indented code

// Some comments
line 1 of code
line 2 of code
line 3 of code

Block code "fences"

var foo = function (bar) {
  return bar++;
};

Tables

| Aspect   | Description | Cost |
| --------- | ----------- | ----:|
| Layout    | Use the vertical bar character to specify column edges. | $100.00 |
| Alignment | Use a trailing ':' in the column divider to right align a column. | $100,000.00  |
| Borders   | Table styles show borders at the top and bottom of the table body. | $1  |


Table with a left column header:

|                                 |             |
| -------------------------------:| ----------- |
| **Tables with a column header** | To create a table with a left column header, add |
| **Foo**                         | a ':' character at the end of the left columns'  |
| **Bar**                         | top header divider. |

Aspect	Description	Cost
Layout	Use the vertical bar character to specify column edges.	$100.00
Alignment	Use a trailing ':' in the column divider to right align a column.	$100,000.00
Borders	Table styles show borders at the top and bottom of the table body.	$1

Table with a left column header:


Tables with a column header	To create a table with a left column header, add
Foo	a ':' character at the end of the left columns'
Bar	top header divider.

Links

[link text](https://www.roobrick.org).
[link with title](https://www.roobrick.org "title text!").
Autoconverted link hhttps://www.roobrick.org.

link text.
link with title.
Autoconverted link hhttps://www.roobrick.org.

Images

![Roobrick logo](https://www.roobrick.org/img/roobrick-logo-v4-256x256.png)
![Roobrick logo](https://www.roobrick.org/img/roobrick-logo-v4-256x256.png "Roobrick logo")
Like links, Images also have a footnote style syntax
![Alt text][id]
With a reference later in the document defining the URL location:
[id]: https://www.roobrick.org/img/roobrick-logo-v4-256x256.png  "Roobrick logo"

Like links, Images also have a footnote style syntax
![Alt text][id]
With a reference later in the document defining the URL location:
[id]: https://www.roobrick.org/img/roobrick-logo-v4-256x256.png "Roobrick logo"

Footnotes

Footnote 1 link[^first].
Footnote 2 link[^second].
Inline footnote^[Text of inline footnote] definition.
Duplicated footnote reference[^second].
[^first]: Footnote **can have markup**
    and multiple paragraphs.
[^second]: Footnote text.

Footnote 1 link^[1].
Footnote 2 link^[2].
Inline footnote^[Text of inline footnote] definition.
Duplicated footnote reference^[2].

Footnote can have markup
and multiple paragraphs. ↩
Footnote text. ↩ ↩

You may also like some of our other posts...