diff options
| author | Patrick Wendell <pwendell@gmail.com> | 2014-09-18 10:30:17 -0700 |
|---|---|---|
| committer | Patrick Wendell <pwendell@gmail.com> | 2014-09-18 10:30:17 -0700 |
| commit | 3ad4176cf980591469997a8a612bf422c90f86fd (patch) | |
| tree | 90d4761f1feba02ddb97d4fa91c84bc9d38470d2 /docs/README.md | |
| parent | 3447d100900af15a7340a2f6a5430ffb6d9c6c23 (diff) | |
| download | spark-3ad4176cf980591469997a8a612bf422c90f86fd.tar.gz spark-3ad4176cf980591469997a8a612bf422c90f86fd.tar.bz2 spark-3ad4176cf980591469997a8a612bf422c90f86fd.zip | |
SPARK-3579 Jekyll doc generation is different across environments.
This patch makes some small changes to fix this problem:
1. We document specific versions of Jekyll/Kramdown to use that match
those used when building the upstream docs.
2. We add a configuration for a property that for some reason varies across
packages of Jekyll/Kramdown even with the same version.
Author: Patrick Wendell <pwendell@gmail.com>
Closes #2443 from pwendell/jekyll and squashes the following commits:
54ee2ab [Patrick Wendell] SPARK-3579 Jekyll doc generation is different across environments.
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/docs/README.md b/docs/README.md index fdc89d2eb7..79708c3df9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -20,12 +20,16 @@ In this directory you will find textfiles formatted using Markdown, with an ".md read those text files directly if you want. Start with index.md. The markdown code can be compiled to HTML using the [Jekyll tool](http://jekyllrb.com). -To use the `jekyll` command, you will need to have Jekyll installed. -The easiest way to do this is via a Ruby Gem, see the -[jekyll installation instructions](http://jekyllrb.com/docs/installation). -If not already installed, you need to install `kramdown` and `jekyll-redirect-from` Gems -with `sudo gem install kramdown jekyll-redirect-from`. -Execute `jekyll build` from the `docs/` directory. Compiling the site with Jekyll will create a directory +`Jekyll` and a few dependencies must be installed for this to work. We recommend +installing via the Ruby Gem dependency manager. Since the exact HTML output +varies between versions of Jekyll and its dependencies, we list specific versions here +in some cases: + + $ sudo gem install jekyll -v 1.4.3 + $ sudo gem uninstall kramdown -v 1.4.1 + $ sudo gem install jekyll-redirect-from + +Execute `jekyll` from the `docs/` directory. Compiling the site with Jekyll will create a directory called `_site` containing index.html as well as the rest of the compiled files. You can modify the default Jekyll build as follows: |