Open Socialism Website

Introduction

This repo is for opensocialism.com, a democratic capitalism alternative.

How to contribute.

Technical

Technologies

• Docker
• Jekyll
• Sass
• Markdown

Requirements

Docker (must include docker-compose) is required for local development. If on windows, either install the linux subsystem, or run the docker-compose commands directly.

Running the site locally

auto/run

Site can be accessed at http://localhost:4000

Running with the full nav build

This takes ~20 seconds to build, which can be annoying to wait for when making a lot of changes.

auto/prod-environment

Verifying changes

This currently checks:

• the links are valid with html-proofer
• spelling mistakes via hunspell
• yaml issues with yamllint
• docker issues with hadolint
• shell issues with shellcheck

auto/verify/verify-all

Adding new words to be skipped by the spell checker

Update the custom dictionary file. I don't understand the format very well..

Updating the gems

auto/update/update-gems

Refreshing ruby / docker version

Check that the ruby version still matches with https://pages.github.com/versions (which shows the ruby version that github actually uses to build github pages sites). Then run:

auto/update/update-docker

Browser Support

The latest version of the major browsers.