Page design guide
This is a basic overview of which features you can use to design a MkDocs page. You can find more information at https://squidfunk.github.io/mkdocs-material/reference/.
Normal paragraph
You write normal paragraph text just by typing like this.
Preview
You write normal paragraph text just by typing like this.
Headings
You can create headings by placing a # before the text like so:.
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
Preview
Heading 1
Heading 2
Heading 3
Heading 4
Inserting links
You can insert links by:
I want to insert a link [here](https://www.researcher.aau.dk/contact/claaudia)
Preview
I want to insert a link here
Code in paragrapgh
You use backticks to `write code in text`.
Preview
You use backticks to write code in text
.
Console codeblocks
You can also create a console codeblock like so:
```console
ssh -l xxxxxx@student.aau.dk ai-fe02.srv.aau.dk
```
Preview
ssh -l xxxxxx@student.aau.dk ai-fe02.srv.aau.dk
Python codeblocks
You can also create a Python codeblock like so:
```py
import tensorflow as tf
for i in range(len(100)):
print(i)
```
Preview
import tensorflow as tf
for i in range(len(100)):
print(i)
Call-outs
You can make call-outs/admonitions like so:
!!! info "This is the title"
This is the content
Preview
This is the title
This is the content
Data tables
You can also create data tables like this:
| Method | Description |
| ----------- | --------------- |
| `GET` | Fetch resource |
| `PUT` | Update resource |
| `DELETE` | Delete resource |
Preview
Method | Description |
---|---|
GET |
Fetch resource |
PUT |
Update resource |
DELETE |
Delete resource |
Custom HTML/CSS
<div>
<p>
You can paste your own custom HTML/CSS as you would in a normal .html file
</p>
</div>
Preview
You can paste your own custom HTML/CSS as you would in a normal .html file
Inserting images
You can insert images from urls or by uploading images to "/assets/img/":
![Image of CLAAUDIA Logo](../../assets/img/claaudia-logo.pngg)
Preview