Natron's Website

Natron's new jekyll-powered website! See it live at https://wilkinson.graphics/NatronGitHub.github.io/.

Development

We're open to any contributions! To contribute, make sure you have a decent grasp of these things:

• The command line
• Web design
• HTML/CSS and SCSS
• Some prior experience with Jekyll

Note that if you're a beginner programmer and this is your first time working on an open-source project, we advise you to read the detailed development guide. The process described below assumes a pre-existing knowledge of version control systems and Jekyll in general. If that's ok with you, follow these steps to quickly get started:

Getting Dependencies

Make sure you have git already installed. This website also requires Jekyll, a static site generator we use to generate markup from templates. Installing Jekyll should be quick and easy:

• Step 1: Install rbenv via brew install rbenv on Macs, sudo apt install rbenv on Debian Linux distros, yay -S rbenv on Arch-based distros, or compiling manually from its sources at https://github.com/rbenv/rbenv
• Step 2: Run rbenv init and open a new terminal
• Step 3: Run the command rbenv install 2.7.3 && rbenv global 2.7.3
• Step 4: Now, open a new terminal again, and run gem install bundler && bundler install bundler - this gives you access to the bundle command which (confusingly) is what installs Jekyll!

Building With Jekyll

Now, get the sources of the website:

git clone https://github.com/Shrinks99/NatronGitHub.github.io && cd NatronGitHub.github.io

Build with Jekyll in three steps:

• bundle install to install all the dependencies
• bundle exec jekyll build to build the site
• bundle exec jekyll serve to start Jekyll at http://localhost:4000

Navigate to http://localhost:4000 in the browser and get going!

Development Guidelines

Classes

Name classes that are page specific with the following format:

pageprefex-previousclass-classname

Example:

index-featurecards-cardbody

Globally styled containers don't need to be mentioned in these names.

Indenting & Code Styling

Keep indenting clean and follow the existing standards of the files.

Relative Links

Jekyll is a static site generator and relative file URLs don't really work unless you hardcode them which requires thinking and doesn't work for stuff like navigation. To fix this there is a file called baseurl.html that tells Jekyll how to link things nicely and relatively! Place {{base}} directly before any link that links to a resource inside the website and refer to this resource as a path straight from the home directly. Think of it as automatically handling the ../'s for you... because that's exactly what it's doing! For more information see this website.

SVGs & Colours In General

All colour variables are referenced as both P3 and an sRGB fallback. Variables can be found and set in _sass/_global.scss.

SVGs can only have their colours set with variables if they exist in the DOM. This matters most for SVGs set to our brand colours & 100% white. If the SVG is not using these colours it doesn't have to be embedded! Otherwise, it should be.

Licensing

Websites are tricky, licensing is mixed.

• Our website code is licensed under the GPL V2
• Our website content is licensed under something to be determined!
• Inter (our primary font) is licensed under the SIL Open Font License.
• BoxIcons is licensed under CC-BY 4.0.
• Sass MQ is licensed under the MIT License.