blob: b42d40923974877388b23d58817295464ec02f93 (
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
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/wireguard-config/:
make serve
* It will pick up changes and reload pages automatically.
Upgrading dependencies
----------------------
* To upgrade Ruby & Node.js dependencies & push them to the repository:
make maintenance
* Manually upgrade Ruby dependencies:
bundle update
* Manually upgrade Node.js dependencies:
npm update
make browserify
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.
Node.js dependencies
--------------------
For IP address parsing and validation, [ipaddr.js] was used originally.
It is pre-built for browser use, which is nice; however, it's [buggy].
It was replaced by [ip-address], which is not browser-ready; instead,
[Browserify] is used to turn it into a suitable .js file.
This whole situation sucks, but I really want to keep this website static.
TODO: find other options or wait until ipaddr.js fixes the bug.
[ipaddr.js]: https://github.com/whitequark/ipaddr.js
[buggy]: https://github.com/whitequark/ipaddr.js/issues/160
[ip-address]: https://github.com/beaugunderson/ip-address
[Browserify]: https://browserify.org/
|
