Skip to content

Commit a2ed46e

Browse files
edited contribute/index.md to include Jekyll instructions for Windows
1 parent 30041fb commit a2ed46e

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

contribute/index.md

+23
Original file line numberDiff line numberDiff line change
@@ -110,3 +110,26 @@ Replace `GH_VERSION` with the version number that is displayed next to github-pa
110110
111111
- then the site can be built with `bundle exec jekyll serve`
112112
- The site should then be visible on `127.0.0.1:4000`
113+
114+
#### Windows
115+
116+
- First of all, you will have to have Git installed on your system. In a command terminal, type `git version`. If you get a version number, you have Git installed. Otherwise, follow the instructions [here](https://gitforwindows.org/)
117+
- You will mainly want to follow [this installation guide](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll?platform=windows):
118+
- Go to [Ruby](https://www.ruby-lang.org/en/), download windows installer, eg from [here](https://www.ruby-lang.org/en/documentation/installation/#rubyinstaller)
119+
- Run the installer file to install ruby
120+
- Once the installer is ready, you can check Ruby by opening a terminal and typing `ruby -v` . A version number should be displayed.
121+
- Install bundler
122+
- In the terminal, type `gem install bundler`
123+
124+
- If you get an error message "Cannot create directory, filename too long", you have to enable long file paths for Git on your system. Open a command prompt, running it as an administrator.
125+
- Then type `git config --system core.longpaths true`
126+
127+
- Assuming Git is already installed on your system, now you can clone the https://github.com/sentinel-hub/custom-scripts/ repository to a folder on your computer (if you haven't already):
128+
- Navigate to the parent folder, right-click and select "Git GUI Here", and type `git clone https://github.com/sentinel-hub/custom-scripts/`
129+
- Now you are ready to set up jekyll. Navigate to the main folder of the cloned repository ("custom-scripts")
130+
- Type `bundle install` and wait for the process to finish
131+
- Now type `bundle exec jekyll serve` and wait for the local server to generate ("generating..."). You will see the message with the address of the local server, eg. "Server address : http://127.0.0.1:4000"
132+
- Copy this address to a web browser, and you will see the web version of the custom script repository, but with all of your local changes included. This will allow you to test layouts and the effects of your changes. If you make a change to a file you are displaying in Jekyll, save it and wait for the regenerating process to run. You will see the message in the Git GUI window:
133+
'Regenerating: 1 file(s) changed
134+
... done in XX seconds`
135+
If everything looks OK, you can commit, push and create a [pull request](https://github.com/sentinel-hub/custom-scripts/pulls).

0 commit comments

Comments
 (0)