Skip to content

CalyxOS/calyxos.org

Repository files navigation

CalyxOS website

Directory layout

  • pages: The source content for the site.
  • docs: Rendered static pages. These are not committed to this repo.

Building the static pages

Prerequisites:

sudo apt install git ruby bundler build-essential libxml2 libxslt1.1 zlib1g-dev

Clone git repo:

git clone https://gitlab.com/CalyxOS/calyxos.org.git -b main

Install gems for development

cd calyxos.org
gem install bundler
bundle install --path=vendor

Install gems for deployment

cd calyxos.org
gem install bundler
bundle config set deployment true
bundle

Build the static pages:

rake build

To view the pages via a local server:

rake develop

Update the firmware release download links:

rake update-releases

Update the app list:

rake update-app-list

Alternatie debian package install

Typically, ruby is distributed with a Gemfile, which uses the bundle and gem commands to install the particular versions of ruby libraries (gems) that are needed.

However, on Debian, many gems are also packages as Debian packages. Installing using Debian packages may be easier if you are not familar with ruby.

First, make sure buster-backports is enabled. Then install the dependencies:

sudo apt-get install -t buster-backports \
  jekyll ruby-jekyll-feed ruby-jekyll-toc ruby-rouge
rm -f Gemfile Gemfile.lock
jekyll serve

Adding pages

To modify the navigation menu, edit the file pages/_data/menu.yml.

A page can be in the form of page-name.md or page-name/index.md.

To add a new/blog post, create a file under pages/_posts in the form YYYY-MM-DD-title.md.

To make linking easier, you can use wiki-style links. For example:

[[install]] or [[install firmware => install]]

By adding links in this way, the links will still be valid even if you move the 'install' page to a different path in the page hierarchy.

Deployment

The 'main' branch of this git repository is automatically deployed to https://calyxos.org

It is automatically deployed to https://calyxos.gitlab.io/calyxos.org/

Development

Development is done on Gerrit - for more details see the contribution guide

External Sources

Data from these places are pulled in to help generate this site:

The images on this site are sourced from:

Branding

Color definitions:

  • --calyx-light: rgba(154, 202, 60, 1) aka #9ACA3C
  • --calyx-base: rgba(98, 128, 38, 1) aka #628026
  • --calyx-dark: rgba(78, 102, 31, 1) aka #4E661F