Merge pull request #4 from ethereumjs/update-website

Update website

Author: holgerd77

.gitignore

@@ -0,0 +1,4 @@
+_site
+.sass-cache
+.jekyll-metadata
+Gemfile.lock

Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gem 'github-pages', group: :jekyll_plugins

README.md

@@ -1,60 +1,58 @@
-This is a collection of libraries and utilities for [Ethereum](https://ethereum.org).
-
-## Use cases
-
-### Creating an online wallet?
-
-Check out [keythereum](https://github.com/ethereumjs/keythereum) or [ethereumjs-wallet](https://github.com/ethereumjs/ethereumjs-wallet) (with HD wallet support) for managing keys and [ethereumjs-tx](https://github.com/ethereumjs/ethereumjs-tx) for creating transactions with them.
-[ethereumjs-icap](https://github.com/ethereumjs/ethereumjs-icap) might also come handy for dealing with the ICAP (Ethereum in IBAN) format.
-
-### Creating a Dapp?
-
-You will need to interface with the Ethereum network. [web3.js](https://github.com/ethereum/web3.js) provides a complete Javascript API to interact with the RPC interface. If looking for a more lightweight option, [ethereumjs-abi](https://github.com/ethereumjs/ethereumjs-abi) or [solidity.js](https://github.com/ethereumjs/solidity.js) can handle the ABI encoding.
-
-### Interested in running a node?
-
-See [node-blockchain-server](https://github.com/ethereumjs/node-blockchain-server). It is in a pretty rough state at the moment, but at least can download the blockchain.
-
-## Full list of repos
-
-* [browser-builds](https://github.com/ethereumjs/browser-builds): browser builds of ethereumjs libraries
-* [common](https://github.com/ethereumjs/common): the genesis data for the blockchain
-* [ethashjs](https://github.com/ethereumjs/ethashjs): [Ethash](https://github.com/ethereum/wiki/wiki/Ethash) in Javascript
-* [ethereumjs-abi](https://github.com/ethereumjs/ethereumjs-abi): ABI encoding and decoding
-* [ethereumjs-account](https://github.com/ethereumjs/ethereumjs-account): account schema encoding, decoding and validation
-* [ethereumjs-block](https://github.com/ethereumjs/ethereumjs-block): block schema encoding, decoding and validation
-* [ethereumjs-blockchain](https://github.com/ethereumjs/ethereumjs-blockchain): manage a blockchain
-* [ethereumjs-codesim](https://github.com/axic/ethereumjs-codesim): run EVM or Solidity code and examine the output
-* [ethereumjs-icap](https://github.com/ethereumjs/ethreumjs-icap): utilities for handling ICAP (Ethereum in IBAN) encoding
-* [ethereumjs-lib](https://github.com/ethereumjs/ethereumjs-lib): meta package for loading the other ethereumjs- modules
-* [ethereumjs-testing](https://github.com/ethereumjs/ethereumjs-testing): transforms the [official test vectors](https://github.com/ethereum/tests) to a format suitable for ethereumjs
-* [ethereumjs-tx](https://github.com/ethereumjs/ethereumjs-tx): transaction creation, manipulation, signing and verification
-* [ethereumjs-units](https://github.com/ethereumjs/ethereumjs-units): Ethereum unit conversion
-* [ethereumjs-util](https://github.com/ethereumjs/ethereumjs-util): a collection of frequently used methods by the other libraries
-* [ethereumjs-wallet](https://github.com/ethereumjs/ethereumjs-wallet): lightweight toolkit for managing Ethereum keys, including HD wallet support
-* [ethereumjs-vm](https://github.com/ethereumjs/ethereumjs-vm): a complete EVM (Ethereum Virtual Machine) and state processing implementation
-* [geth.js](https://github.com/ethereumjs/geth.js): start and stop geth from Node.js
-* [helpeth](https://github.com/ethereumjs/helpeth): purists' commandline tool for key and transaction management
-* [keythereum](https://github.com/ethereumjs/keythereum): create, import and export Ethereum keys
-* [merkle-patricia-tree](https://github.com/ethereumjs/merkle-patricia-tree): This is an implementation of the modified merkle patricia tree as specified in the [Ethereum yellow paper](http://gavwood.com/Paper.pdf)
-* [node-blockchain-server](https://github.com/ethereumjs/node-blockchain-server): aims to provide a full Ethereum node implementation
-* [node-devp2p](https://github.com/ethereumjs/node-devp2p): implementation of the [RLPx](https://github.com/ethereum/devp2p/blob/master/rlpx.md) transport protocol for Ethereum (used between nodes)
-* [node-devp2p-dpt](https://github.com/ethereumjs/node-devp2p-dpt): implementation of the [RLPx](https://github.com/ethereum/devp2p/blob/master/rlpx.md) DPT (peer table) protocol for Ethereum
-* [node-devp2p-eth](https://github.com/ethereumjs/node-devp2p-eth): implementation of the Ethereum sub-protocol over RLPx
-* [node-devp2p-manager](https://github.com/ethereumjs/node-devp2p-manager): peer manager for DPT & RLPx
-* [organization](https://github.com/ethereumjs/organization) and [ideas](https://github.com/ethereumjs/ideas): plans and discussions
-* [rlp](https://github.com/ethereumjs/rlp): [RLP (Recursive Length Prefix)](https://github.com/ethereum/wiki/wiki/RLP) encoding and decoding
-* [testrpc](https://github.com/ethereumjs/testrpc): fast Ethereum RPC node for testing and development
-
-
-## Ethereum JS projects not tracked here
-* [web3.js](https://github.com/ethereum/web3.js): the complete API as seen in the [wiki](https://github.com/ethereum/wiki/wiki/JavaScript-API)
-* [solidity.js](https://github.com/ethereum/solidity.js): ABI encoding and decoding (the relevant code split out from web3.js)
-
-## Contributing and contact
-
-Please check out [organization](https://github.com/ethereumjs/organization) and [ideas](https://github.com/ethereumjs/ideas) repos first.  Contributing to each of the projects is preferably done via pull requests.
-
-You can also reach out on:
-* [Gitter](https://gitter.im/ethereum/ethereumjs-lib)
-* [#ethereumjs](https://webchat.freenode.net/?channels=ethereumjs) on freenode
+# SYNOPSIS
+
+[![Gitter](https://img.shields.io/gitter/room/ethereum/ethereumjs-lib.svg?style=flat-square)](https://gitter.im/ethereum/ethereumjs-lib) or #ethereumjs on freenode 
+
+# 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) ``2.4.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:
+
+```
+jekyll build
+```
+
+And being served on http://127.0.0.1:4000 with:
+
+```
+jekyll serve
+```
+
+
+

_config.yml

@@ -1,8 +1,16 @@
-title: ethereumjs
-description: Your Javascript gateway to Ethereum
+title: EthereumJS
+description: Your Javascript Gateway to Ethereum
+repository: ethereumjs
 google_analytics: 
 show_downloads: true
 theme: jekyll-theme-cayman
 
 gems:
   - jekyll-mentions
+  - jekyll-github-metadata
+
+sass:
+  load_paths:
+    - assets/css                        # original sass
+
+

_includes/repository.html

@@ -0,0 +1,26 @@
+{% for repository in site.github.public_repositories  %}
+{% if repository.name == include.name %}
+<pre id="github-pages-metadata" style="display:none;"></pre>
+<script>document.getElementById("github-pages-metadata").innerHTML = JSON.stringify({{ repository | jsonify }}, null, 4);</script>
+<div class="repo-box">
+  <div class="repo-header">
+    <div class="repo-header-right">
+      {{ repository.stargazers_count }} <i class="fa fa-star"></i>&nbsp;&nbsp;
+      
+      <a href="{{ repository.html_url }}" alt="GitHub URL">
+        <i class="fa fa-github"></i>
+      </a>
+    </div>
+    {{ repository.name }}
+  </div>
+  <div class="repo-description">
+    {{ repository.owner_name }}
+    {{ repository.description }}
+  </div>
+</div>
+
+
+
+
+{% endif %}
+{% endfor %}

assets/css/style.scss

@@ -0,0 +1,79 @@
+---
+---
+
+@import "{{ site.theme }}";
+@import "../font-awesome/scss/font-awesome";
+
+h1 {
+  margin-bottom: 25px !important;
+}
+
+.page-header a {
+  display: none;
+}
+
+.intro-text {
+  background-color: #caefdc;
+  padding: 20px;
+  font-size: 1.2rem;
+  text-align: center;
+}
+
+.repo-group {
+  width: 100%;
+  float: left;
+}
+
+@media only screen and (min-width: 650px) {
+	.repo-group {
+    width: 47%;
+    padding-right: 3%;
+  }
+}
+
+.repo-group h3 {
+  border-bottom: 1px solid #159957;
+}
+
+.repo-group p {
+  margin-bottom: 22px;
+}
+
+.repo-group .repo-box {
+  margin-bottom: 15px;
+}
+
+.repo-group .repo-header {
+  background-color: #018372;
+  padding: 5px 8px 5px 8px;
+  color: #fff;
+}
+
+.repo-group .repo-header a {
+  color: #fff;
+}
+
+.repo-group .repo-header-right {
+  float: right;
+}
+
+.repo-group ul {
+  font-size: 0.94rem;
+}
+
+.repo-group .repo-description {
+  border: 1px solid #018372;
+  padding: 5px 8px 5px 8px;
+  font-size: 0.9rem;
+  min-height: 75px;
+}
+
+.separator {
+  clear: both;
+  height: 35px;
+}
+
+.attribution {
+  margin-top: 40px;
+  font-size: 0.9rem;
+}

assets/font-awesome/HELP-US-OUT.txt

@@ -0,0 +1,7 @@
+I hope you love Font Awesome. If you've found it useful, please do me a favor and check out my latest project,
+Fort Awesome (https://fortawesome.com). It makes it easy to put the perfect icons on your website. Choose from our awesome,
+comprehensive icon sets or copy and paste your own.
+
+Please. Check it out.
+
+-Dave Gandy