Skip to content

Achievements Section

joe.c.starr edited this page Jan 25, 2024 · 1 revision

When editing be careful to write correctly formatted YAML. In YAML indentation matters. A short intro to YAML can be found here.


Description

The achievements section is the seventh section displayed on the landing page. It's intended to list achievements attained.

image

  achievements:
    enable: true
    title: "Awards"
    items:
      - title: Some fellowship
        content: |-
           Donec viverra ultricies aliquam. Praesent at bibendum mi, quis euismod dolor. Vivamus vel diam quis turpis gravida commodo non vitae lacus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Nunc commodo justo ipsum, eget consequat nibh semper a. Etiam fermentum lectus sapien
      - title: Some other fellowship
        content: Praesent at bibendum mi, quis euismod dolor.
        image: /images/Pythagoras.jpeg
        url: https://example.com

Configuration

Enable

true/false if set to false will hide the achievements section.

achievements:
    enable: true

title

Optional field that replaces the "achievements" title with a custom title for the section.

  achievements:
    ...
    title: "Awards"

items

A list of achievements earned. Configure as a valid YAML list.

  achievements:
    ...
    items:
      - title: Some fellowship
        content: |-
           Donec viverra ultricies aliquam. Praesent at bibendum mi, quis euismod dolor. Vivamus vel diam quis turpis gravida commodo non vitae lacus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Nunc commodo justo ipsum, eget consequat nibh semper a. Etiam fermentum lectus sapien
      - title: Some other fellowship
        content: Praesent at bibendum mi, quis euismod dolor.
        image: /images/Pythagoras.jpeg
        url: https://example.com

List item

The list items have 2 required fields and 2 optional fields

Required

title

The title of the achievements box. Reference image.

  achievements:
    ...
    items:
      - title: Some fellowship
content

A string that lists the contextual info. Reference picture. Note: |- tells yaml to expect a multi-line string, white space is important here.

  achievements:
    ...
    items:
      - ...
        content: |-
           Donec viverra ultricies aliquam. Praesent at bibendum mi, quis euismod dolor. Vivamus vel diam quis turpis gravida commodo non vitae lacus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Nunc commodo justo ipsum, eget consequat nibh semper a. Etiam fermentum lectus sapien

Optional

image

The url for an image to include at the top of the award box. Reference picture.

  achievements:
    ...
    items:
      - ...
        image: /images/Pythagoras.jpeg
url

Enabling this turns the whole award box into a button. Clicking the award box will navigate to configured url.

  achievements:
    ...
    items:
        -...
        url: https://example.com