Commit 917c1200 authored by tron's avatar tron
Browse files

revised readme

parent 8029f39c
Pipeline #20975 passed with stage
in 14 minutes and 10 seconds
......@@ -42,36 +42,38 @@ menu:
href: "/other"
```
### Lists
- News
- logo="path/image.png"
- tags = "tagA, TagB, ..." | tags = "tagA"
- maxItems = Int
- noHeadline="true"
- noToggle="true"
```yaml
{% include news logo="path/image.png" tags = "tagA, TagB, ..." maxItems = 6 %}
{% include news logo="path/image.png" tags = "tagA, TagB, ..." maxItems = 6 noHeadline="true" noToggle="true" %}
```
- Jobs
- tags = "tagA, TagB, ..." | tags = "tagA"
- maxItems = Int
- noHeadline="true"
- noToggle="true"
```yaml
{% include jobs tags = "tagA, TagB, ..." maxItems = 6 %}
{% include jobs tags = "tagA, TagB, ..." maxItems = 6 noHeadline="true" noToggle="true" %}
```
- Topics
- tags = "tagA, TagB, ..." | tags = "tagA"
- status = "open" | "closed" | "assigned"
- headline="string, md, html"
```yaml
## Theses and projects
{% include topics tags="tagA, TagB, ..." status = "open" %}
{% include topics tags="tagA, TagB, ..." status = "assigned" %}
{% include topics tags="tagA, TagB, ..." status = "closed" %}
```
1. News
```
{% include news tags = "yourTag" maxItems = 6 %}
```
Accepted arguments:
- `tags`: list of comma-separate tags. Used to filter all news.
- `maxItems`: `int` number of items to display
- `logo`:Path to image relative to `./images`
- `noHeadline`: disables default headline
- `noToggle`: disables `show more` button
2. Jobs
```
{% include jobs tags = "yourTag" maxItems = 6 %}
```
Accepted arguments:
- `tags`: list of comma-separate tags. Used to filter all news.
- `maxItems`: `int` number of items to display
- `logo`:Path to image relative to `./images`
- `noHeadline`: disables default headline
- `noToggle`: disables `show more` button
3. Topics
```
## Theses and projects
{% include topics tags="yourTag" status = "open" %}
{% include topics tags="yourTag" status = "assigned" %}
{% include topics tags="yourTag" status = "closed" %}
```
Accepted arguments:
- `tags`: list of comma-separate tags. Used to filter all news.
- `status`: accepts `open`, `closed` and `assigned`
- `headline`: overrides default headline
### Image Carousel
The teaser images at the top can be selected for each page individually with a default in the `_config.yml` as:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment