docs

Grid landing page

Our landing page is hosted by GitHub Pages, from master branch, /docs directory and can be accessed on https://grid.ethereum.org.

GitHub Pages uses Jekyll plugin (Ruby) to build html pages.

1. Add a GitHub access token to your environment

Depending on your shell, you'll need to add it to ~/.bash_profile, ~/.bashrc, ~/.zshrc, etc.

See detailed instructions.

# appending token information
echo "export JEKYLL_GITHUB_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" >> ~/.bash_profile

# reloading current shell
source ~/.bash_profile

2. Make sure you have a working Ruby environment.

# execute on your terminal
ruby -v

https://jekyllrb.com/docs/

Ruby >2.2.5 is good, although it is recommended to use a version >= 2.3. If your current environment doesn't meet the criteria, please refer to the installation guide.

3. Install required Ruby gems

cd docs/
gem install bundler jekyll
bundle install

4. Run local server

bundle exec jekyll serve --incremental

Default URL is http://127.0.0.1:4000/

If you need to force-rebuild the site in case you get some stubborn cache, please run:

bundle exec jekyll clean
bundle exec jekyll build

Additional resources

• Setting up your GitHub Pages site locally with Jekyll
• Liquid (template engine used by Jekyll)
• Jekyll documentation
• GitHub Pages help