Basic examples

Title

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

More titles

Some more titles

And some more titles

Unordered lists

• Lorem ipsum dolor sit amet,
• consectetur adipiscing elit,
• sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Unordered lists with different indentation

• aaa
• bbb
  • ccc
  • ddd
  • eee
  • fff
• ggg
• hhh

Ordered lists

1. Lorem ipsum dolor sit amet,
2. consectetur adipiscing elit,
3. sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Mixed lists with different indentation

1. aaa
2. bbb
   1. ccc
      • ddd
      • eee
      • fff
   2. ggg
3. hhh
4. iii

Ordered lists (the easy way)

If you are in a lazy mood, you can let markdown calculate the numbers. Just use 1. for all list entries, instead of 1., 2., 3., ... (see the source code in the markdown file).

1. Lorem ipsum dolor sit amet,
2. consectetur adipiscing elit,
3. sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Tip: Editors with markdown support often fix these numbers automatically.

Direct downloads

Download the following test file.

Source code

Some pretty code:

public void test() {
    String words = "Hello world!";
    int[] numbers = {0, 1, 42, 1337};

    System.out.println(words);

    // Print each number in the array
    for (int n : numbers) {
        System.out.println(n);
    }

    System.out.println("Well this is a very long line of code, I wonder how it will wrap? Do you know? I am very curious ... . Well, let's find out, shall we!");
}

This MkDocs theme uses Pygments to provide syntax highlighting. All available languages are defined here, use the short name as the language identifier for the fenced code blocks in markdown. There is also support for highlighting CLI output:

user@localhost:~$ echo blabla
blabla
user@localhost:~$  for i in {0..5}; do echo "${i}"; done
0
1
2
3
4
5
user@localhost:~$ export dir="demo"
user@localhost:~$ mkdir "/tmp/${dir}"
user@localhost:~$ cd "/tmp/${dir}"
user@localhost:/tmp/demo$ echo "Hello world!" > test.txt
user@localhost:/tmp/demo$ ls -al
total 4
drwxr-xr-x.  2 user    user     60 19 mrt 11:21 .
drwxrwxrwt. 32 root    root    940 19 mrt 11:21 ..
-rw-r--r--.  1 user    user     13 19 mrt 11:21 test.txt
user@localhost/tmp/demo$ cat test.txt
Hello world!

PS C:\Users\user> Write-Host blabla
blabla
PS C:\Users\user> 0..5 | ForEach-Object { Write-Output $_ }
0
1
2
3
4
5
PS C:\Users\user> $dir = "demo"
PS C:\Users\user> New-Item -ItemType Directory -Path "C:\temp\${dir}"

    Directory: C:\temp\

UnixMode   User             Group                 LastWriteTime           Size Name
--------   ----             -----                 -------------           ---- ----
drwxr-xr-x user             user                3/19/2024 11:26             40 demo

PS C:\Users\user> Set-Location "C:\temp\${dir}"
PS C:\temp\demo> Set-Content -Path "test.txt" -Value "Hello world!"
PS C:\temp\demo> Get-ChildItem

    Directory: C:\temp\demo

UnixMode   User             Group                 LastWriteTime           Size Name
--------   ----             -----                 -------------           ---- ----
-rw-r--r-- user             user                3/19/2024 11:26             13 test.txt

PS C:\temp\demo> Get-Content test.txt
Hello world!

You can even link to a specific line in a fenced code block.

Inline source code

Variables iso, iso_size and destination belong to function copy_iso_to_usb().

Citation

Some pretty quote:

The problem with quotes found on the internet is, that they are often not true. ~ Abraham Lincoln.

Some text here.

Links, bold, italic, strikethrough

Link to website .

You can also just type the URL: https://www.hogent.be .

Text in bold.

Italic text.

This text has been stricken.

Math

You can use LaTeX / MathJax math notations:

\[ S_n(x)=\sum_{k=1}^n \frac{\sin(kx)}{k} \gt 0\quad (n\geq 1,\quad 0 \lt x \lt \pi) \]

Tables

Left-aligned	Middle-aligned	Right-aligned	Auto
aaa	bbb	ccc	ddd
000	111	222	333

Tip: Editors with markdown support often auto align markdown tables so they also look pretty in the source code. Saves you a lot of spaces to type!

Images

Some pretty image:

Some text here.

GIF's