updated install instructions
This commit is contained in:
@ -5,7 +5,7 @@ keywords: jekyll on windows, pc, ruby, ruby dev kit
|
||||
sidebar: mydoc_sidebar
|
||||
---
|
||||
|
||||
{{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}}
|
||||
{{site.data.alerts.tip}} For a better terminal emulator on Windows, use [Git Bash](https://git-for-windows.github.io/). Git Bash gives you Linux-like control on Windows. {{site.data.alerts.end}}
|
||||
|
||||
## Install Ruby
|
||||
|
||||
@ -32,26 +32,39 @@ Some extensions Jekyll uses require you to natively build the code using the Rub
|
||||
|
||||
If you get stuck, see the [official instructions for installing Ruby Dev Kit](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit).
|
||||
|
||||
<h2 id="bundler">Install the Jekyll gem</h2>
|
||||
|
||||
At this point you should have Ruby and Rubygem on your machine.
|
||||
|
||||
Now use `gem` to install Jekyll:
|
||||
|
||||
```
|
||||
gem install jekyll
|
||||
```
|
||||
|
||||
You can now use Jekyll to create new Jekyll sites following the quick-start instructions on [Jekyllrb.com](http://jekyllrb.com).
|
||||
|
||||
## Installing dependencies through Bundler
|
||||
|
||||
Some Jekyll themes will require certain Ruby gem dependencies. These dependencies are stored in something called a Gemfile, which is packaged with the Jekyll theme. You can install these dependencies through Bundler. (Although you don't need to install Bundler for this Documentation theme, it's a good idea to do so.)
|
||||
|
||||
[Bundler](http://bundler.io/) is a package manager for RubyGems. You can use it to get all the gems (or Ruby plugins) that you need for your Jekyll project.
|
||||
|
||||
You install Bundler by using the gem command with RubyGems:
|
||||
|
||||
|
||||
## Install Bundler
|
||||
|
||||
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`
|
||||
2. Initialize Bundler: `bundle init`
|
||||
|
||||
This will create a new Gemfile.
|
||||
|
||||
4. Open the Gemfile in a text editor.
|
||||
3. Open the Gemfile in a text editor.
|
||||
|
||||
Typically you can open files from the Command Prompt by just typing the filename, but because Gemfile doesn't have a file extension, no program will automatically open it. 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. Then paste in the following:
|
||||
4. Remove the existing contents. Then paste in the following:
|
||||
|
||||
```
|
||||
source "https://rubygems.org"
|
||||
@ -61,20 +74,15 @@ If you get stuck, see the [official instructions for installing Ruby Dev Kit](ht
|
||||
```
|
||||
The [wdm gem](https://rubygems.org/gems/wdm/versions/0.1.1) allows for the polling of the directory and rebuilding of the Jekyll site when you make changes. This gem is needed for Windows users, not Mac users.
|
||||
|
||||
|
||||
6. Save and close the file.
|
||||
7. Type `bundle install`.
|
||||
|
||||
Bundle retrieves all the needed gems and gem dependencies and downloads them to your computer. At this time, Bundle also takes a snapshot of all the gems used in your project and creates a Gemfile.lock file to store this information.
|
||||
|
||||
## Serve the Jekyll site
|
||||
## Serve the Jekyll Documentation theme
|
||||
|
||||
1. Browse to the jekyll theme directory.
|
||||
1. Browse to the directory where you downloaded the Documentation theme for Jekyll.
|
||||
2. Type `jekyll serve`
|
||||
3. Go to the preview address in the browser. (Make sure you include the `/` at the end.)
|
||||
|
||||
Unfortunately, the Command Prompt doesn't allow you to easily copy and paste the URL, so you'll have to type it manually.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Bundler retrieves the latest version of the jekyll gem that is compatible with the github-pages gem. Unfortunately, in my testing, I think that version of the jekyll gem has some issues with the kramdown gem. Later versions of the jekyll gem fix the kramdown compatibility issues. If you run into this issue, let me know (especially if you solved it).
|
||||
|
Reference in New Issue
Block a user