jekyll/site/docs/installation.md

2.3 KiB
Raw Blame History

layout title prev_section next_section permalink
docs Installation home usage /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 (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 youll need to make sure your system has before you start.

Running Jekyll on Windows

It is possible to get Jekyll running on Windows, but the official documentation does not support installation on Windows platforms.

Install with RubyGems

The best way to install Jekyll is via RubyGems. At the terminal prompt, simply run the following command to install Jekyll:

{% highlight bash %} $ gem install jekyll {% endhighlight %}

All Jekylls gem dependencies are automatically installed by the above command, so you wont have to worry about them at all. If you have problems installing Jekyll, check out the troubleshooting page or report an issue so the Jekyll community can improve the experience for everyone.

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 syntax highlighting of code snippets using Pygments, LaTeX support, and the use of alternative content rendering engines. Check out the extras page for more information.

ProTip™: Enable Syntax Highlighting

If youre the kind of person who is using Jekyll, then chances are youll want to enable syntax highlighting using Pygments. You should really check out how to do that before you go any further.

Now that youve got everything installed, lets get to work!