Merge pull request #5817 from DirtyF/pull/installation

Merge pull request 5817
This commit is contained in:
jekyllbot 2017-01-27 11:37:03 -05:00 committed by GitHub
commit 1ff59026f1
2 changed files with 33 additions and 16 deletions

View File

@ -10,18 +10,29 @@ 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.
Installing Jekyll should be straight-forward if all requirements are met.
Before you start, make sure your system has the following:
- [Ruby](https://www.ruby-lang.org/en/downloads/) (including development
headers, v1.9.3 or above for Jekyll 2 and v2 or above for Jekyll 3)
- GNU/Linux, Unix, or macOS
- [Ruby](https://www.ruby-lang.org/en/downloads/) version 2.0 or above, including all development
headers
- [RubyGems](https://rubygems.org/pages/download)
- Linux, Unix, or macOS
- [NodeJS](https://nodejs.org/), or another JavaScript runtime (Jekyll 2 and
earlier, for CoffeeScript support).
- [Python 2.7](https://www.python.org/downloads/) (for Jekyll 2 and earlier)
- [GCC](https://gcc.gnu.org/install/) and [Make](https://www.gnu.org/software/make/) (in case your system doesn't have them installed, which you can check by running `gcc -v` and `make -v` in your system's command line interface)
#### Only required for Jekyll 2 and earlier
- [NodeJS](https://nodejs.org/), or another JavaScript runtime (for CoffeeScript support).
- [Python 2.7](https://www.python.org/downloads/)
<div class="note info">
<h5>Problems installing Jekyll?</h5>
<p>
Check out the <a href="../troubleshooting/">troubleshooting</a> page or
<a href="{{ site.repository }}/issues/new">report an issue</a> so the
Jekyll community can improve the experience for everyone.
</p>
</div>
<div class="note info">
<h5>Running Jekyll on Windows</h5>
<p>
@ -42,10 +53,7 @@ $ gem install jekyll
```
All of 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](../troubleshooting/) page or
[report an issue]({{ site.repository }}/issues/new) so the Jekyll
community can improve the experience for everyone.
command, so you wont have to worry about them at all.
<div class="note info">
<h5>Installing Xcode Command-Line Tools</h5>

View File

@ -36,6 +36,15 @@ If you installed the above - specifically on Fedora 23 - but the extensions woul
sudo dnf install redhat-rpm-config
```
On Ubuntu if you get stuck after `bundle exec jekyll serve` and see error
messages like `Could not locate Gemfile` or `.bundle/ directory`, it's likely
because all requirements have not been fully met. Recent stock Ubuntu
distributions require the installation of both the `ruby` and `ruby-all-dev`
packages:
```sh
sudo apt-get install ruby ruby-all-dev
```
On [NearlyFreeSpeech](https://www.nearlyfreespeech.net/) you need to run the
following commands before installing Jekyll: