aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/DEVELOPMENT.md
blob: e66581408861edd05c7539a63df1a35b093018c4 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
Workspace setup
---------------

* To reduce pain, set up [rbenv] to manage your Ruby versions.
Install one that's known to work:

      make ruby

    * Otherwise, make sure you have Ruby and [Bundler] set up.

* Install dependencies:

      make deps

* Make sure builds are working:

      make build

[rbenv]: https://github.com/rbenv/rbenv
[Bundler]: https://bundler.io/

Development
-----------

* Build the website and serve it at http://localhost:4000/blog/:

      make serve

    * It will pick up changes and reload pages automatically.

Upgrading dependencies
----------------------

* To upgrade dependencies in Gemfile.lock & push them to the repository:

      make maintenance

* Manually upgrade dependencies in Gemfile.lock:

      bundle update

Building static pages
---------------------

If you try to copy the _site directory and open index.html without running the
web server, it won't work: all links will be messed up.
Jekyll doesn't provide native support for generating a static website which can
be browsed without running a web server.

One workaround is to `wget` the website:

    make serve LIVE_RELOAD=0    # Live reloading breaks wget
    make wget

The truly static version will be downloaded to the .wget/ directory.