HPCE/gitea-pages
0
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Activity

added more robust instructions for installing jekyll on windows and mac

Browse Source
This commit is contained in:
tomjohnson1492
2016-03-24 12:17:03 -07:00
parent 283dfa3b73
commit fb11fbbee9
10 changed files with 630 additions and 385 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
mydoc/mydoc_install_jekyll_on_windows.md
View File

@ -34,6 +34,7 @@ sidebar: mydoc_sidebar
{% endcomment %}
{{site.data.alerts.tip}} For a better terminal emulator on Windows, download <a href="https://sourceforge.net/projects/console/">Console</a>. This terminal allows you to create tabs and gives you more functionality. {{site.data.alerts.end}}
## Install Ruby
@ -44,29 +45,42 @@ sidebar: mydoc_sidebar
## Install Ruby Development Kit
1. Go to [RubyInstaller for Windows](http://rubyinstaller.org/downloads/).
2. Under the **Development Kit** section near the bottom, download one of the **For use with Ruby 2.0 and above...** options.
3. Extract Ruby onto your **C** drive in a folder called something like **RubyDevKit**.
3. Browse to the **RubyDevKit** location on your C drive using your Command Line Prompt.
3. Type `ruby dk.rb init`
3. Type `ruby dk.rb install`
2. Under the **Development Kit** section near the bottom, download one of the **For use with Ruby 2.0 and above...** options (either the 32-bit or 64-bit version).
3. Move your downloaded file onto your **C** drive in a folder called something like **RubyDevKit**.
4. Extract the compressed folder's contents into the folder.
5. Browse to the **RubyDevKit** location on your C drive using your Command Line Prompt.
{{site.data.alerts.tip}} To see the contents of your current directory, type <code>dir</code>. To drill into a directory, type <code>cd foldername</code>, where "foldername" is the name of the folder you want to enter. To move up a directory, type <code>cd ../</code>. To move into your user's directory, type <code>/users</code>.{{site.data.alerts.end}}
6. Type `ruby dk.rb init`
7. Type `ruby dk.rb install`
If you get stuck, see the [official instructions for installing Ruby Dev Kit](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit).
## Install Bundler
1. In the downloaded theme, *delete* the existing **Gemfile** and **Gemfile.lock** files.
1. Type `gem install bundler`.
2. Browse to the documentation-jekyll-theme directory.
3. Type `bundle init`
4. Open the Gemfile in a text editor.
5. Paste in the following:
1. Using the command line, browse to the folder where you downloaded the Jekyll theme.
2. Delete the existing **Gemfile** and **Gemfile.lock** files:
```
del Gemfile
del Gemfile.lock
```
1. Install Bundler: `gem install bundler`
3. Initialize Bundler: `bundle init`
This will create a new Gemfile.
4. Open the Gemfile in a text editor. You may need to use your File Explorer and browse to the directory, and then open the Gemfile in a text editor such as Notepad.
5. Remove the existing contents and paste in the following:
```
# A sample Gemfile
source "https://rubygems.org"
gem 'wdm', '>= 0.1.0' if Gem.win_platform?
gem 'jekyll', '~> 3.1', '>= 3.1.2'
gem 'wdm'
gem 'jekyll'
```
6. Save and close the file.
@ -74,6 +88,6 @@ If you get stuck, see the [official instructions for installing Ruby Dev Kit](ht
## Serve the Jekyll site
1. Browse to the documentation-jekyll-theme directory.
1. Browse to the jekyll theme directory.
2. Type `jekyll serve`
3. Go to the preview address in the browser. (Make sure you include the `/` at the end.)