@@ -53,9 +53,20 @@ to review it as soon as we can.
53
53
### Working On The Builder
54
54
55
55
The ` builder ` is the static site generator that turns the markdown files, CSS,
56
- images, and scripts into a website. It lives in the ` builder ` . Most of the time,
57
- you won't need to make changes to the builder and you can follow the
58
- instructions in the _ Contributing Changes_ section above.
56
+ images, and scripts into a website.
57
+
58
+ > [ !NOTE]
59
+ > The package in the builder folder has the ` haskell-org-site ` executable:
60
+ > ```
61
+ > $ cat cabal.project
62
+ > packages: builder
63
+ >
64
+ > $ cat builder/haskell-org.cabal | grep executable
65
+ > executable haskell-org-site
66
+ > ```
67
+
68
+ Most of the time, you won't need to make changes to the builder and you can
69
+ follow the instructions in the _Contributing Changes_ section above.
59
70
60
71
If you want to make a quick change or two, you can continue to use the
61
72
`buildAndWatch` script to rebuild changes, but for more substantial changes this
@@ -66,24 +77,20 @@ builder using either nix or cabal. Directions for both are given below:
66
77
### Manually Building the Site With Cabal
67
78
68
79
If you don't have nix installed, or if you are inside of the project's nix
69
- shell, you will want to use cabal to compile the builder. To do so, enter the
70
- ` builder ` directory and compile the program with:
80
+ shell, use cabal to build and execute the builder, the only package in
81
+ the project.
71
82
72
- ``` shell
73
- cabal v2-build
83
+ ```
84
+ $ cabal build all
85
+ $ cabal exec haskell-org-site build
74
86
```
75
87
76
- Once compiled, the builder must be run from the project root directory so that
77
- it can find all of the content. To run the builder, you need to first find the
78
- name of the executable. From the builder directory, you can find the executable
79
- path by running:
88
+ With `cabal run` we can do this in one command.
80
89
81
90
```
82
- cabal v2-exec -- which haskell-org-site
91
+ $ cabal run haskell-org-site -- build
83
92
```
84
93
85
- Using that path, you can run the builder from the project root directory.
86
-
87
94
### Manually Building the Site With Nix
88
95
89
96
If you have nix installed, you can have nix build the builder by running:
0 commit comments