COMP2120 Course Markdown and Submission Guide

You can alse see more examples and other best practices on markdownguide.org

Headings#

You can use the following headings in your submitted markdown files for some formatting if you choose to do so:

Heading 3 text#

• ### <Heading 3 text>

Heading 4 text#

• #### <Heading 4 text>

Avoid using Heading 5 or 6 as they are a bit hard to read as they are a bit too small.

Formatting#

Bold text#

You can bold text by using the following syntax:

**<bold text here>** -> bold text here

Italics#

You can italicise text by using the following syntax:

*<italic text here>* -> italic text here

Ordered list#

You can create an ordered list by using the following syntax:

1. <list item 1>

2. <list item 2>

3. <list item 3>

1. list item 1
2. list item 2
3. list item 3

Unordered list#

You can create an unordered list by using the following syntax:

- <list item 1>

- <list item 2>

- <list item 3>

• list item 1
• list item 2
• list item 3

Code#

You can create a code block by using beginning the code block with three “`” characters (```) and ending the code block with three “`” characters (```).

```java
class COMP2120 {
    public static void main(String[] args)
    {
        System.out.println("Hello World!");
    }
}

```
class COMP2120 {

    public static void main(String[] args)
    {
        System.out.println("Hello World!");
    }
}
```

Inline code is also supported by starting with a single ` and ending with another single `

System.out.println("Hello World!");

`System.out.println("Hello World!");`

Links#

comp2120

[comp2120](https://comp.anu.edu.au/courses/comp2120/)

Images#

You can insert an image by using the following syntax:

Figure 1: Link to ANU School of Computing Image - ![ANU School of Computing](https://comp.anu.edu.au/assets/images/computing.jpg)

![alt text](https://image.com/image.png)

Alternatively, if the image is stored locally, within the same file or can be navigated to, you can use the following syntax:

Figure 2: Navigating to a local image - ![ANU School of Computing](assets/images/computing.jpg)

![alt text](path-to-image.png)

If the image is located within the same folder as the file, you can use the following syntax:

![ANU School of Computing](computing.jpg)

Tables#

You can create tables in markdown using the following syntax.

```
| Column 1 | Column 2 | Column 3 |
| -------- | -------- | -------- |
| Text     | Text     | Text     |
| Text     | Text     | Text     |
| Text     | Text     | Text     |
```

Footnotes#

Here’s a sentence with a footnote. ¹

Here's a sentence with a footnote. [^1]

[^1]: This is a footnote