105 lines
3.5 KiB
Markdown
105 lines
3.5 KiB
Markdown
---
|
||
layout: docs
|
||
title: Installation
|
||
prev_section: quickstart
|
||
next_section: usage
|
||
permalink: /docs/installation/
|
||
---
|
||
|
||
Getting Jekyll installed and ready-to-go should only take a few minutes. If it
|
||
ever becomes a pain in the ass, please [file an
|
||
issue]({{ site.repository }}/issues/new) (or submit a pull request)
|
||
describing the issue you encountered and how we might make the process easier.
|
||
|
||
### Requirements
|
||
|
||
Installing Jekyll is easy and straight-forward, but there are a few requirements
|
||
you’ll need to make sure your system has before you start.
|
||
|
||
- [Ruby](http://www.ruby-lang.org/en/downloads/)
|
||
- [RubyGems](http://rubygems.org/pages/download)
|
||
- Linux, Unix, or Mac OS X
|
||
|
||
<div class="note info">
|
||
<h5>Running Jekyll on Windows</h5>
|
||
<p>
|
||
While Windows is not officially supported, it is possible to get it running
|
||
on Windows. Special instructions can be found on our
|
||
<a href="../windows/#installation">Windows-specific docs page</a>.
|
||
</p>
|
||
</div>
|
||
|
||
## Install with RubyGems
|
||
|
||
The best way to install Jekyll is via
|
||
[RubyGems](http://docs.rubygems.org/read/chapter/3). At the terminal prompt,
|
||
simply run the following command to install Jekyll:
|
||
|
||
{% highlight bash %}
|
||
$ gem install jekyll
|
||
{% endhighlight %}
|
||
|
||
All of Jekyll’s gem dependencies are automatically installed by the above
|
||
command, so you won’t have to worry about them at all. If you have problems
|
||
installing Jekyll, check out the [troubleshooting](../troubleshooting/) page or
|
||
[report an issue]({{ site.repository }}/issues/new) so the Jekyll
|
||
community can improve the experience for everyone.
|
||
|
||
<div class="note info">
|
||
<h5>Installing Xcode Command-Line Tools</h5>
|
||
<p>
|
||
If you run into issues installing Jekyll's dependencies which make use of
|
||
native extensions and are using Mac OS X, you will need to install Xcode
|
||
and the Command-Line Tools it ships with. Download in
|
||
<code>Preferences → Downloads → Components</code>.
|
||
</p>
|
||
</div>
|
||
|
||
## Pre-releases
|
||
|
||
In order to install a pre-release, make sure you have all the requirements
|
||
installed properly and run:
|
||
|
||
{% highlight bash %}
|
||
gem install jekyll --pre
|
||
{% endhighlight %}
|
||
|
||
This will install the latest pre-release. If you want a particular pre-release,
|
||
use the `-v` switch to indicate the version you'd like to install:
|
||
|
||
{% highlight bash %}
|
||
gem install jekyll -v '2.0.0.alpha.1'
|
||
{% endhighlight %}
|
||
|
||
If you'd like to install a development version of Jekyll, the process is a bit
|
||
more involved. This gives you the advantage of having the latest and greatest,
|
||
but may be unstable.
|
||
|
||
{% highlight bash %}
|
||
$ git clone git://github.com/jekyll/jekyll.git
|
||
$ cd jekyll
|
||
$ script/bootstrap
|
||
$ bundle exec rake build
|
||
$ ls pkg/*.gem | head -n 1 | xargs gem install -l
|
||
{% endhighlight %}
|
||
|
||
## Optional Extras
|
||
|
||
There are a number of (optional) extra features that Jekyll supports that you
|
||
may want to install, depending on how you plan to use Jekyll. These extras
|
||
include LaTeX support, and the use of alternative content rendering engines.
|
||
Check out [the extras page](../extras/) for more information.
|
||
|
||
<div class="note">
|
||
<h5>ProTip™: Enable Syntax Highlighting</h5>
|
||
<p>
|
||
If you’re the kind of person who is using Jekyll, then chances are you’ll
|
||
want to enable syntax highlighting using <a href="http://pygments.org/">Pygments</a>
|
||
or <a href="https://github.com/jayferd/rouge">Rouge</a>. You should really
|
||
<a href="../templates/#code_snippet_highlighting">check out how to
|
||
do that</a> before you go any farther.
|
||
</p>
|
||
</div>
|
||
|
||
Now that you’ve got everything installed, let’s get to work!
|