Skip to content

Education 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 education section is the third section displayed on the landing page. It's intended to list degrees attained or in progress.

image

  education:
    enable: true
    # title: "Custom Name"
    index: false
    items:
      - title: "tellus sit amet pulvinar"
        school:
          name: "Hermodamas of Samos"
          url: "https://en.wikipedia.org/w/index.php?title=Hermodamas_of_Samos&action=edit&redlink=1"
        date: "595 BC - 590 BC"
      - title: "Quisque consectetur"
        school:
          name: "Pherecydes of Syros"
          url: "https://en.wikipedia.org/wiki/Pherecydes_of_Syros"
        date: "595 BC - 590 BC"
        GPA: "3.9 out of 5.0"
        content: |-
          In dolor dolor, eleifend at leo a, viverra convallis risus. Aliquam eu leo
          diam. Vivamus at urna dignissim, venenatis dolor ut, laoreet elit.
          Lorem ipsum dolor sit amet, consectetur adipiscing elit.
        featuredLink:
          enable: true
          name: "My academic record"
          url: "https://example.com"

Configuration

Enable

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

  education:
    enable: true

title

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

  education:
    ...
    # title: "Custom Name"

index

true/false controls if the section is indexed for search. No need to change.

  education:
    ...
    index: false

items

A list of educational experiences. Configure as a valid YAML list.

  education:
    ...
    items:
      - title: "tellus sit amet pulvinar"
        school:
          name: "Hermodamas of Samos"
          url: "https://en.wikipedia.org/w/index.php?title=Hermodamas_of_Samos&action=edit&redlink=1"
        date: "595 BC - 590 BC"
      - title: "Quisque consectetur"
        school:
          name: "Pherecydes of Syros"
          url: "https://en.wikipedia.org/wiki/Pherecydes_of_Syros"
        date: "595 BC - 590 BC"
        GPA: "3.9 out of 5.0"
        content: |-
          In dolor dolor, eleifend at leo a, viverra convallis risus. Aliquam eu leo
          diam. Vivamus at urna dignissim, venenatis dolor ut, laoreet elit.
          Lorem ipsum dolor sit amet, consectetur adipiscing elit.
        featuredLink:
          enable: true
          name: "My academic record"
          url: "https://example.com"

List item

The list items have 2 required fields and 4 optional fields

Required

title

The title of the education box. Reference image.

  education:
    ...
    items:
      - title: "Quisque consectetur"
school

Contains two fields that describe the school attended.

  • name - a string for the name of the school.
  • url - a string for the link to the school.
  education:
    ...
    items:
      - ...
        school:
          name: "Pherecydes of Syros"
          url: "https://en.wikipedia.org/wiki/Pherecydes_of_Syros"

Optional

date

A string that lists the dates attended. Reference picture.

  education:
    ...
    items:
      - ...
        date: "595 BC - 590 BC"
GPA

A string that lists the gpa information. Reference picture.

  education:
    ...
    items:
      - ...
        GPA: "3.9 out of 5.0"
content

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

  education:
    ...
    items:
      - ...
        content: |-
          In dolor dolor, eleifend at leo a, viverra convallis risus. Aliquam eu leo
          diam. Vivamus at urna dignissim, venenatis dolor ut, laoreet elit.
          Lorem ipsum dolor sit amet, consectetur adipiscing elit.
FeaturedLink

This contains three fields that include a button to link to external resources. Reference picture.

  • enable - true/false to show the button
  • name - label to display on the button.
  • url - the url to navigate to when button is pressed.
  education:
    ...
    items:
        -...
        featuredLink:
          enable: true
          name: "My academic record"
          url: "https://example.com"