Project Elara website

This is Project Elara's website, the most up-to-date and authoritative source of information about Project Elara. This includes project announcements and news, as well as guides to our work and links to our subprojects.

Support Project Elara

If you'd like to help fund our work, you can support us on OpenCollective:

Getting started

The site is a static site, built on Zola. To get started, download Zola from the Zola releases page. The version is important - we use the same Zola version as the Alpine Linux Zola package, so this should be the same version that you install.

Ensure that upon installing Zola, the version should be checked by running zola --version to confirm you are not using a different/outdated version of Zola, and consult the alpine linux zola package version to find the version that the website uses. While you can try building the site with other versions of Zola, we cannot guarantee it will work!

Afterwards, clone the git repository with:

git clone https://codeberg.org/elaraproject/website.git elara-website
cd elara-website

To enforce a consistent code style, we use dprint for code formatting. You may install dprint using their official installation instructions. After installing dprint, you can use the dprint fmt command for formatting the code (there are also extensions for VS Code, IntelliJ IDEs, Zed, and Sublime Text that run dprint for you (plus this hack to make it work with Vim), so you don't have to do it manually). Then, set up the pre-commit Git hook as follows:

cp ./scripts/githooks/pre-commit .git/hooks/pre-commit

Note

Please make sure to ensure your code has been formatted before any commit or Git will raise an error via the pre-commit hook.

In addition, we use the Inter font for the website, but as Inter is not licensed under the public domain, we cannot host its font files in this repository. We provide a Python script to automatically download and extract the font files (and Inter's license information) instead. Simply run:

# for older systems that have Python 2 and 3,
# replace `pip` and `python` with `pip3` and `python3`
pip install requests
python extract_fonts.py

Likewise, we also use the RPI logo and RCOS logo, which are taken from the open-source project Submitty's website repository as neither logo is pubic domain. This is also downloaded via a Python script:

python extract_partner_icons.py

Assuming you have run all the scripts, you can now begin developing the website. You can start a local web server to preview your changes by running:

zola serve

This should open a local developer server to live-reload the website.

Important As one of Project Elara's most important repositories, this repository has branch protections, meaning that it is strongly recommended to make your changes on a separate branch or on a fork instead of committing directly on the main branch.

Developer information

The site is built on templates in the templates/ folder. The pages themselves are in content/ with a few exceptions (such posters, our logo, and icons) in the static/ folder. Each page is markdown with some pages including a bit of HTML where it's necessary.

Page variables are specified in YAML format like so:

+++var1 = value1var2 = value2# ...+++

The variables include the following:

• title: the name of the page, placed in double-quotes
• date: the date the page was first published, in YYYY-MM-DD format
• description: a short description of the page, placed in double-quotes
• Several variables placed below [extra]
  • author: for news pages only, the name of the person who wrote the article
  • subtitle (only on homepage): the subheader text of the front page

Writing news articles

News/blog articles are located within the content/news folder. Here is a basic template to get started with writing one:

+++
title = "Title of your article"
date = YYYY-MM-DD
[extra]
author = "Your name"
+++
Give a short (<4 sentences) summary of your article here.
<!-- more -->
This is the main body of the article, you can make this section as long as you'd like.

Designer information

Project Elara's color palette and design system are available in the sass/site.scss stylesheet, and should be easy to test and modify as they are all encapsulated in the Sass variables at the top of the stylesheet. Additionally, after running zola serve, you can navigate to the localhost:XXXX/design page for a live preview of the design system.

Translator information

If you speak a non-English language fluently and would like to help translate, please see the translators documentation for more information.

Licensing info

This website is released to the public domain. You may freely use it for any purpose.