Teaching Section

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

---

Description

The teaching section is the sixth section displayed on the landing page. It's intended to list teaching activities and context for the class.

  teaching:
    enable: true
    # title: "Custom Name"
    index: false
    items:
      - title: "Triangles 101"
        info:
          name: "University technical college"
          url: "https://en.wikipedia.org/w/index.php?title=Hermodamas_of_Samos&action=edit&redlink=1"
        date: "Fall 590 BC"
      - title: "Circles 101"
        info:
          name: "University technical college"
          url: "https://en.wikipedia.org/w/index.php?title=Hermodamas_of_Samos&action=edit&redlink=1"
        date: "Spring 591 BC"
        content: |-
            - Lorem ipsum dolor sit amet consectetur adipisicing elit.
            - Tempora esse, eaque delectus nulla quo doloribus itaque expedita alias natus optio totam maxime nihil excepturi velit a animi laborum hic similique.
       featuredLink:
          enable: true
          name: "Syllabus"
          url: "https://example.com"

---

Configuration

Enable

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

  teaching:
    enable: true

title

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

  teaching:
    ...
    # title: "Custom Name"

index

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

  teaching:
    ...
    index: false

items

A list of teaching given. Configure as a valid YAML list.

  teaching:
    ...
    items:
      - title: "Triangles 101"
        info:
          name: "University technical college"
          url: "https://en.wikipedia.org/w/index.php?title=Hermodamas_of_Samos&action=edit&redlink=1"
        date: "Fall 590 BC"
      - title: "Circles 101"
        info:
          name: "University technical college"
          url: "https://en.wikipedia.org/w/index.php?title=Hermodamas_of_Samos&action=edit&redlink=1"
        date: "Spring 591 BC"
        content: |-
            - Lorem ipsum dolor sit amet consectetur adipisicing elit.
            - Tempora esse, eaque delectus nulla quo doloribus itaque expedita alias natus optio totam maxime nihil excepturi velit a animi laborum hic similique.
       featuredLink:
          enable: true
          name: "Syllabus"
          url: "https://example.com"

List item

The list items have 2 required fields and 4 optional fields

Required

title

The title of the teaching box. Reference image.

  teaching:
    ...
    items:
      - title: "Circles 101"

info

Contains two fields that describe the info attended.

• name - a string for the name of the info.
• url - a string for the link to the info.

  teaching:
    ...
    items:
      - ...
        info:
          name: "University technical college"
          url: "https://en.wikipedia.org/w/index.php?

Optional

date

A string that lists the dates. Reference picture.

  teaching:
    ...
    items:
      - ...
        date: "Spring 591 BC"

content

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

  teaching:
    ...
    items:
      - ...
        content: |-
            - Lorem ipsum dolor sit amet consectetur adipisicing elit.
            - Tempora esse, eaque delectus nulla quo doloribus itaque expedita alias natus optio totam maxime nihil excepturi velit a animi laborum hic similique.

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.

  teaching:
    ...
    items:
        -...
        featuredLink:
          enable: true
          name: "Syllabus"
          url: "https://example.com"