Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ethereumjs/ethereumjs.github.io
Website for an intro to the EthereumJS ecosystem
https://github.com/ethereumjs/ethereumjs.github.io
ethereumjs website
Last synced: about 2 months ago
JSON representation
Website for an intro to the EthereumJS ecosystem
- Host: GitHub
- URL: https://github.com/ethereumjs/ethereumjs.github.io
- Owner: ethereumjs
- License: mit
- Created: 2015-12-16T21:41:30.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-08-02T19:52:56.000Z (over 1 year ago)
- Last Synced: 2024-04-04T12:58:54.156Z (9 months ago)
- Topics: ethereumjs, website
- Language: CSS
- Homepage: https://ethereumjs.github.io
- Size: 576 KB
- Stars: 11
- Watchers: 25
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SYNOPSIS
[![Discord][discord-badge]][discord-link]
# 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](https://pages.github.com) and
build with [Jekyll](https://jekyllrb.com/) (see also ["Jekyll and GH Pages"](https://help.github.com/articles/using-jekyll-as-a-static-site-generator-with-github-pages/)).
It uses the [Cayman](https://github.com/jasonlong/cayman-theme) theme available as an option on GitHub.
# SITE UPDATES
You can update the site by editing the markdown in [./index.md](./index.md) (via PR), build will be
triggered automatically on merge.
For information on repository metadata on GitHub pages see [this](https://help.github.com/articles/repository-metadata-on-github-pages/) article.
Custom CSS can be added in [./assets/css/style.scss](./assets/css/style.scss).
# LIBRARY INCLUDES
The website uses [Font Awesome](http://fontawesome.io/) ``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](https://www.ruby-lang.org) ``3.2 .x`` environment (you can use the [RVM](https://rvm.io/) 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](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/) 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
```
[discord-badge]: https://img.shields.io/static/v1?logo=discord&label=discord&message=Join&color=blue
[discord-link]: https://discord.gg/TNwARpR