Skip to content

Commit 2e3fddb

Browse files
added local website build instructions for Jekyll website
1 parent bb850d9 commit 2e3fddb

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

website/README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,37 @@
11
This folder contains the code for our website:
22
[https://cds-registration.lfenergy.org/](https://cds-registration.lfenergy.org/)
3+
4+
5+
## How to run your own copy of this website
6+
7+
* On Ubuntu 24.04+ or Debian 13+, install `jekyll`.
8+
9+
```
10+
sudo apt install jekyll
11+
```
12+
13+
* Navigate to this website's folder in the repo.
14+
15+
```
16+
cd website/
17+
```
18+
19+
* Copy the specifications from the base repo folder to the website include folder.
20+
21+
```
22+
cp ../specifications/cds-wg1-01.md _includes/spec_copies/placeholder_cds-wg1-01.md
23+
cp ../specifications/cds-wg1-02.md _includes/spec_copies/placeholder_cds-wg1-02.md
24+
```
25+
26+
* Run the jekyll server, which builds the website and starts serving it on https://localhost:4000/
27+
28+
```
29+
jekyll serve
30+
```
31+
32+
* Done!
33+
34+
**Note:** If you want to make changes to the specifications themselves (to make a pull request, etc.), you need to modify them in the `specifications/` folder, not the `spec_copies/` folder.
35+
Then, you will need to re-copy them to the `spec_copies/` folder for the changes to show up on your local website.
36+
Finally, when you're done with your changes, you need to commit changes in the `specifications/` folder and not commit any changes to the `spec_copies/` folder.
37+
Our automated build process for the official website will automatically copy over the specifications when a new version is built.

0 commit comments

Comments
 (0)