You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I tried to describe more thoroughly the process of contributing to the website.
I also updated the guide in order to use `bundle install` and `bundle exec
jekyll [cmd]` now that a Gemfile is present.
To setup a development enviroment locally, you need to have Ruby installed; you
31
+
can follow [this guide](https://www.ruby-lang.org/en/documentation/installation/) to install it.
32
+
Once you have Ruby installed, `cd` into the forked project and run
30
33
31
-
3. Test it locally, you need to install the gems `jekyll` and `redcarpet`:
34
+
```bash
35
+
$ bundle install
36
+
```
37
+
38
+
in order to download and install all the necessary dependencies and
32
39
33
40
```bash
34
-
$ gem install jekyll redcarpet
35
-
$ jekyll serve # check localhost:4000
41
+
$ bundle exec jekyll serve
36
42
```
37
43
38
-
4. Push to your forked repository.
44
+
to run a development server (with live-reloading on) on port 4000.
45
+
46
+
Now you're ready to make your changes! Be sure to test the changes locally using
47
+
the development server. Once you're done with your changes, push those changes
48
+
to your fork and then submit a **pull request**.
39
49
40
-
5. Submit a pull-request for your changes.
50
+
#### JavaScript processor
41
51
42
-
`jekyll` requires a javascript processor to be available too. Many OS provide such functionality but others do not. If you have an error related to ExecJS, you can work around it by either running `gem install therubyracer` or by ensuring node.js is available in your path.
52
+
Jekyll (the static-site generator you installed before) requires a JavaScript
53
+
processor to be available. Many operating systems provide such functionality but
54
+
some don't. If you encounter errors related to "ExecJS", you can work around
55
+
them by either installing the `therubyracer` gem (`$ gem install therubyracer`)
56
+
or by ensuring [Node.js](http://nodejs.org) is in your `$PATH`.
0 commit comments