status-im/specs
2
0
Fork 0
mirror of https://github.com/status-im/specs.git synced 2025-01-12 07:04:15 +00:00
Code Issues Projects Releases Wiki Activity
specs/DEVELOPMENT.md
Pascal Precht a39e718a1f Fix development docs to use correct bin path for ruby gems 
Seems like there was a typo in the `PATH` declaration for installed
ruby gem binaries. This causes installed gems to be found.

This commit fixes it by reusing the `GEM_HOME` var so `PATH`
will use `.gems` (not `gems`) as well.
2021-12-08 12:45:54 +01:00

1.1 KiB
Raw Permalink Blame History

permalink title layout
/development DEVELOPMENT default

Description

This file explains the process of local development for this repository.

Dependencies

This repository is built using Jekyll along with some plugins and a theme.

To install the necessary dependencies on Ubuntu use:

sudo apt-get install ruby-full build-essential zlib1g-dev
gem install jekyll bundler

It might be necessary to specify installation destination for your Gems:

export GEM_HOME="$HOME/.gems"
export PATH="$GEM_HOME/bin:$PATH"

For instructions on other systems use these docs.

Then you can install other Gems like the just-the-docs theme:

bundle install

Building

To simply build the site use:

bundle exec jekyll build --config _config_local.yml

This will generate the site files and put them under _site.

But if you want Jekyll to continuously build and also serve the site use:

bundle exec jekyll serve --config _config_local.yml --incremental

This should make it available under http://127.0.0.1:4000/.