The DBPL Website

Hi. If you're here, you're probably a DBPL student or faculty member looking to update the DBPL website. Congratulations, you're in the right place!

You'll need the Zola static site generator. If you don't have that go ahead and install it. See docs.

Making Changes

1. Run zola serve or zola build to make sure the project compiles and looks reasonable.
2. File a merge request against the project.
3. Find someone with access to merge the file in and upload.

If you are part of the DBPL admin group, you can upload by running: bash scripts/publish.sh.

Directory Organization

Landing Page

Source: /content/_index.md
Rendered: /index.html

This is the main landing page. It takes its title from /config.toml, but is otherwise rendered directly.

People Page

Source: /content/people.md
Rendered: /people/index.html

A list of people affiliated with DBPL lives here. Standard templating:

• Link to your homepage using markdown link syntax
• Link to your mastodon page by following your name with {{ mastodon(server=YOUR_SERVER, account=YOUR_USERNAME) }}
• Link to your linkedin page by following your name with {{ linkedin(account=YOUR_LINKEDIN_ID) }}

Templates for the social links can be found in /templates/shortcodes

News

Source: /content/blog/*.md
Rendered: /blog/*.html

Files should be named by posting date: YYYY-MM-DD-Post_Title.md. Each file should have a header containing:

+++
title = "YOUR TITLE HERE"
date = "YYYY-MM-DD"
+++

Featured Projects

Source: /content/projects/*.md
Rendered: /projects/*.html

Projects don't need to have their own page, but they need a template file to provide information. Create a file /content/projects/[your_thing].md and add the following template:

+++
title = "YOUR TITLE HERE"
weight = 3
description = "SHORT BLURB FOR INDEX"
extra.link_to = "https://optional.url.for.direct.linkes"
+++

Featured projects should start with a weight of 3. You should either include a link in the header OR provide a project page in the body of the file.

Theme-ing

At time of writing, the site uses the 'Apollo' theme. You can find its code in themes/apollo. You can find most of the theme's contents in themes/apollo/templates. In general, avoid modifying the theme directly. Instead, find a way to override the theme from within the outer directory. Examples include:

• sass/main.scss: Site-specific CSS overrides.
  • sass/ub_theme.scss: Overrides Apollo's them with UB's Official Color Palette.