Skip to content

Commit 8551cbc

Browse files
committed
Updated documentation on how to install the Jekyll version that comes with github-pages.
1 parent 37dc3d2 commit 8551cbc

File tree

2 files changed

+14
-3
lines changed

2 files changed

+14
-3
lines changed

README-dev.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ Make sure that `build.sh` is called from the main directory. The output will
4848
be in `web-build`.
4949

5050
3. Render the web site and themed documentation, which can be done using Jekyll.
51-
To install Jekyll, follow these
52-
[instructions](https://jekyllrb.com/docs/installation/). Then run
51+
To install Jekyll, follow the instructions in step 2 of
52+
[web/README.md](web/README.md). You only need to do this once. Then run
5353

5454
```
5555
web/serve.sh

web/README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,18 @@ PSI/J repository.
2222
$ sudo pip install -r requirements-docs.txt
2323
```
2424

25-
2. Install Jekyll (see [Jekyll Installation](https://jekyllrb.com/docs/installation/) - also a one-time operation).
25+
2. Install Jekyll prerequisites by following the instructions for your
26+
operating system found in the
27+
[Jekyll installation instructions](https://jekyllrb.com/docs/installation/).
28+
You should skip installing Jekyll itself, since it will be installed by
29+
*bundler*. Then run
30+
```bash
31+
$ cd web
32+
$ bundle update
33+
$ cd ..
34+
```
35+
to install the version of Jekyll used by github-pages. This is a one-time
36+
operation. For subsequent builds, you can skip directly to step 3.
2637

2738
3. Run the build script, which will build the documentation, process
2839
files in the `web` directory, and generate the output in `web-build`:

0 commit comments

Comments
 (0)