EVERSE Website

Overview

This is the source for the EVERSE website. The website is built with the Hugo static website engine and the Blowfish theme.

Directory Layout

The directory layout follows the usual Hugo scheme. The most important directories are:

• content holds the text content for the site, mostly in markdown, which is a very simple markup language
  • The subdirectory structure in the content directory maps to ´website URLs
• assets has content that will be processed by Hugo when building the website - particular images and icons; it also contains any customisation to the CSS styles
• static has content that will be available, but is not processed, e.g., PDFs
• config contains the files that configure Hugo and Blowfish, in particular the menus.yaml file defines the top bar and footer menus

These should be the only directories that you care about if you want to add or update content on the site. If you wish to do some deeper customisation of the site then the layouts directory has page templates and Hugo shortcode files.

Modifying and Adding Content

Setup

You will need to install Hugo and checkout the code for the website from GitHub (actually, it's recommended that you fork the project and work on your own copy).

git clone --recursive https://github.com/MY-GITHUB-USERNAME/EVERSE-ResearchSoftware.github.io 

(The --recursive is needed to get the Blowfish theme submodule.)

Assuming you intent to contribute your changes back to the main EVERSE website, it's best to now create a branch with a meaningful name, from which you will later make a pull request.

Edit

If you want to modify the content of a page, simply open the relevant markdown file and update it. Usual markdown syntax is, of course, supported. You will see use of some special Hugo shortcodes that can do some things that markdown cannot (e.g., the figure shortcode for more image handling options, the flex-columns shortcode for multi-column layouts; Blowish also has bunch of nice shortcodes to make badges, buttons, alerts, etc.).

To add new content:

• Create a new markdown file as it would appear in the website hierarchy. E.g., content/about/wombats.md would create a page that would get rendered, when deployed, to https://everse.software/about/wombats/.
• If necessary, add a menu item for the new page in config/menus.yaml

Preview Changes

Run hugo serve in the base directory of your check that the changes work as you expect.

Pull Request

When you are happy, push the changes to your fork, then make a pull request back to the main EVERSE repository.

Faces of EVERSE

On our webpage we also want to present EVERSE members. Each person can create their own entry with a bit of professional information about themselves.

Your presentation page should contain a few sentences about yourself and a picture. The former is a page in markdown, index.md, with the text about yourself as well as some metadata; the later is just a JPG, which has to be called feature.jpg and should ideally be square and at least 256px each side.

You can prepare this yourself following the instructions below and opening a pull request on the EVERSE webpage repository with SanjeAntona (or graeme-a-stewart) as a reviewer.

In case you don't feel comfortable creating this yourself or you don't have a GitHub account, send all your details (as described in the instructions and templates below) to mailto:sanje.antona.fenkart@cern.ch.

Instructions for creating your own person page

1. Create a new branch from the repository on your local machine (e.g., graeme-everse-page as branch name).
2. Create a new folder in content/about/people/FirstnameLastname containing an index.mdfile.

• You can check the templates (i.e. Graeme Stewart or Sanje Fenkart) for examples of this.

3. Your text profile information should contain: your name, your job title (e.g. "Data scientist", "Training Developer", etc...), your affiliation (your institute or organisation) and 3-4 sentences about yourself and your work.

• Note also the two special short codes that are needed - the first one inserts your picture, the second will process your professional contact/media information.

4. To show your involvement in EVERSE you need to add metadata in the YAML header under params.

• If you are involved in work package N add wpN: true. If you are a work package leader add wpNwpl: true and wpl: true.
• Add also your institute, using the abbreviations here, e.g., institute: CERN.
• Finally, under media add your contact information for the options:

      email: [address]
      github: [link]
      link: [link to website]
      linkedin: [handle link]
      bluesky: [handle link]
      x-twitter: [handle link]

In order for your contact details to be displayed remember the {{< insert-media-links >}} at the end of the file!

• For BlueSky, GitHub and X/Twitter adding the username suffices, the url will be constructed automatically.
• link connects to a webpage of your choice, e.g. a personal website.
• If you don't want to link your email directly, you can also choose to spell out your address and obscure it (me AT my.institute).
• For complete examples see the templates above.

5. Then add a picture of yourself, using the filename feature.jpg, (potrait format/square)! Your jpg should have at least 256 px (or a minimum of 100 KB). You can find the command for the correct layout and insertion for the image in the example files:

{{< figure src="feature.jpg" alt= "photo of Sanje, (C) Christin Hristova, Christop Markus Rist" class="float-right m-2 w-[30%]" >}}

Please add according credit in the alt text and stick to the value in class. If you're the owner/photographer, add "(C) private."

For further information on how to add new content see the instructions on "Modifying and Adding content" above.

You can preview the results locally using hugo or submit a PR and the Netlify infrastructure will generate the page for you. You may have to manually construct the URL to actually see it, by adding about/people/YourName to the preview base URL.

Problems? Issues?

If you see something wrong with the site, or you want to suggest a change, please open a GitHub Issue.

Help

Graeme, Nikos and Aspa can try and help you if you get stuck.