Skip to content

Commit fa51d39

Browse files
authored
Merge pull request #600 from charafau/feat/jekyll_incremental_upgrade
Upgraded project docs to include incremental switch
2 parents 70bfaa3 + 15be8bb commit fa51d39

File tree

1 file changed

+5
-20
lines changed

1 file changed

+5
-20
lines changed

Diff for: README.md

+5-20
Original file line numberDiff line numberDiff line change
@@ -19,29 +19,15 @@ This site uses a Jekyll, a Ruby framework. You'll need Ruby and Bundler installe
1919

2020
cd into the directory where you cloned this repository, then install the required gems with `bundle install`. This will automatically put the gems into `./vendor/bundle`.
2121

22-
Start the server in the context of the bundle:
22+
Start the server in the context of the bundle (use `-I` for incremental builds):
2323

24-
bundle exec jekyll serve
24+
bundle exec jekyll serve -I
2525

26-
The generated site is available at `http://localhost:4000`
27-
28-
If you add `--watch` at the end of the command line above, Jekyll will automatically watch for changes on the filesystem, and regenerate the site. It can take a few minutes for your changes to appear. Watch Jekyll's output. When you start up you'll see this:
29-
30-
$ bundle exec jekyll serve --watch
31-
Configuration file: /Users/ben/src/scala.github.com/_config.yml
32-
Source: /Users/ben/src/scala.github.com
33-
Destination: /Users/ben/src/scala.github.com/_site
34-
Generating...
35-
done.
36-
Auto-regeneration: enabled for '/Users/ben/src/scala.github.com'
26+
`It might take around 5 minutes at first but incremental compilations will be fast.`
3727

38-
When you change a file, this output will tell you that jekyll is regenerating. It's not done until it says `done.`
28+
The generated site is available at `http://localhost:4000`
3929

40-
Server running... press ctrl-c to stop.
41-
Regenerating: 1 files at 2014-11-29 09:19:04 ...done.
42-
Regenerating: 3 files at 2014-11-29 09:21:39 ...done.
43-
Regenerating: 2 files at 2014-11-29 09:25:10 ...done.
44-
Regenerating: 2 files at 2014-11-29 09:27:49
30+
If you add `--watch` at the end of the command line above, Jekyll will automatically watch for changes on the filesystem, and regenerate the site.
4531

4632
If you get `incompatible encoding` errors when generating the site under Windows, then ensure that the
4733
console in which you are running jekyll can work with UTF-8 characters. As described in the blog
@@ -61,4 +47,3 @@ There's a free markdown editor for OSX called [Mou](http://25.io/mou/). It's qui
6147
## License ##
6248

6349
All documentation contained in this repository is licensed by EPFL under a Creative Commons Attribution-Share Alike 3.0 Unported license ("CC-BY-SA"), unless otherwise noted. By submitting a "pull request," or otherwise contributing to this repository, you implicitly agree to license your contribution under the above CC-BY-SA license. The source code of this website is licensed to EPFL under the [Scala License](http://www.scala-lang.org/node/146), unless otherwise noted.
64-

0 commit comments

Comments
 (0)