WS22/23 ULG Data Science

Markdown

Introduction

Markdown is a lightweight markup language for creating formatted documents in minutes using nothing but a plain-text editor. You can use the full range of HTML elements in Markdown and they will not be affected by a Markdown parser. Many code sharing platforms like, e.g., GitHub or GitLab as well as programming languages support Markdown. Actually, the webpage you are looking at right now was created by interweaving HTML and Markdown elements.

Basic Syntax and Formatting

In order to show you the possibilities of formatting text with simple macros we provide the examples below. On top you can see the plain code and below that what Markdown makes of it.

  • Comments

<!--This is a comment.-->
  • Headers of different sizes

# This is an <h1>

## This is an <h2>

### This is an <h3>

#### This is an <h4>

##### This is an <h5>

###### This is an <h6>

This is an <h1>

This is an <h2>

This is an <h3>

This is an <h4>

This is an <h5>
This is an <h6>
  • Formatting text the easy way

_This text is in italics._

This text is in italics.

**This text is bold.**

This text is bold.

**_This text is both._**

This text is both.

> This is a quotation.
> You can also add more levels to go deeper with
>
> > double `>`.

This is a quotation. You can also add more levels to go deeper with

double >.

  • Add a horizontal rule

---

  • Present things in (enumerated) lists

- Item
- Another item
  • Item

  • Another item

1. Item one
2. Item two
  1. Item one

  2. Item two

1. Item one
2. Item two
   - Sub-item
   - Sub-item
3. Item three
  1. Item one

  2. Item two

    • Sub-item

    • Sub-item

  3. Item three

Boxes below without the 'x' are unchecked HTML checkboxes.

- [ ] First task to complete.
- [x] This task has been completed.

Highlighting Code

  • Formatting code inline

`This is code.`
This is code.
  • Code blocks and syntax highlighting

In GitHub Flavored Markdown, you can use a special syntax for code. Just add the programming language of your choice after the three ticks.

```python
def foobar(x: int = 1, y: str = "Hello") -> int:
    print(y)
    return 2 * x
end
```
def foobar(x: int = 1, y: str = "Hello") -> int:
    print(y)
    return 2 * x
end

Here is an example of the R programming language.

```r
jiggle <- function(x) {
    x = x + rnorm(1, sd=.1) # add a bit of (controlled) noise
    return(x)
}
```
jiggle <- function(x) {
    x = x + rnorm(1, sd=.1) # add a bit of (controlled) noise
    return(x)
}
[Click me!](https://www.uibk.ac.at/weiterbildung/ulg/data-science/index.html.en)

Click me!

Also note that

<http://testwebsite.com/>

is equivalent to

[http://testwebsite.com/](http://testwebsite.com/)

Navigating through your local folders and files is possible as well.

[Go to music](/music/).

Before referencing headers or chapter markers you have to label them with (label) first.

- [Heading](#heading)
- [Chapter](#chapter)
  - [Subchapter <h3 />](#subchapter-h3-)

Figures

Including pictures from a local or remote source can be done with

![excel](https://miro.medium.com/max/624/1*FAzumPnvzKUDolMG7SNcHw.png)

excel

Tables

| Col1         |   Col2   |          Col3 |
| :----------- | :------: | ------------: |
| Left-aligned | Centered | Right-aligned |
| foo          |   bar    |           baz |
Col1Col2Col3
Left-alignedCenteredRight-aligned
foobarbaz
CC BY-SA 4.0 - Stephan Antholzer, Gregor Ehrensperger, Johannes Sappl. Last modified: August 31, 2023. Website built with Franklin.jl and the Julia programming language.