SYNOPSIS

INTRODUCTION

Website to give an overview of the various EthereumJS projects and an introduction to the ecosystem and the community.

Site is hosted at https://ethereumjs.github.io/ via GitHub Pages and build with Jekyll (see also "Jekyll and GH Pages").

It uses the Cayman theme available as an option on GitHub.

SITE UPDATES

You can update the site by editing the markdown in ./index.md (via PR), build will be triggered automatically on merge.

For information on repository metadata on GitHub pages see this article.

Custom CSS can be added in ./assets/css/style.scss.

LIBRARY INCLUDES

The website uses Font Awesome v4.7.x for some icons. To update the library download the latest release from the website and replace the un-versioned font-awesome folder in the assets/ folder.

In scss/_variables.scss update the $fa-font-path to point to the ../font-awesome/fonts directory.

LOCAL BUILD

To build the site locally you have to have a working Ruby 3.2 .x environment (you can use the RVM Ruby version manager for this) and bundle and Jekyll installed.

Install the GitHub pages gem from the Gemfile with:

bundle install

See also this article for further installation instructions.

The site can then be build with:

bundle exec jekyll build

And being served on http://127.0.0.1:4000 with:

bundle exec jekyll serve