You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-34
Original file line number
Diff line number
Diff line change
@@ -35,40 +35,15 @@ The complete site's content is based on a json/yaml file per section (e.g., `con
35
35
36
36
## Development
37
37
38
-
This website uses [Jekyll](http://jekyllrb.com/), [Bootstrap 4](http://getbootstrap.com/), [Blueimp Gallery](https://github.com/blueimp/Bootstrap-Image-Gallery), can access the [Flickr API](https://www.flickr.com/services/api/), and [Formspree](http://formspree.io/).
38
+
This website uses [Pug](https://pugjs.org/api/getting-started.html), [Bootstrap 5](http://getbootstrap.com/), [GLightbox](https://biati-digital.github.io/glightbox/), and can access the [Flickr API](https://www.flickr.com/services/api/).
39
39
40
-
#### Setting up the Build Environment (on Windows)
40
+
### Prerequisites
41
+
-[Node.js](https://nodejs.org/en) and [npm](https://www.npmjs.com/) are required for development and testing.
41
42
42
-
For the development and testing of the website jekyll (https://jekyllrb.com/) is required. A fast and simple setup of jekyll, is possible via chocolatey (https://chocolatey.org/) either using the ```setup.bat``` script or proceed as follows (for non-Windows platforms the specific package managers, e.g., apt-get, can be used instead of Chocolatey):
43
+
### Development Commands
44
+
-`npm install` installs all necessary dependencies.
45
+
-`npm start` launches a local server for development and testing.
46
+
-`npm run build:dev` and `npm run build` are used to create the static site.
43
47
44
-
* For installing chocolatey open a command prompt as administrator and run the following command:
* Now close the command prompt and open a new one (not necessarily with administrative priviliges) to install jekyll (which requires ruby) by running:
49
-
```
50
-
choco install ruby -y
51
-
gem install jekyll
52
-
```
53
-
54
-
For deployment of the website, the following optimizations (mostly minimizations) that require node, npm as well as uncss, cssmin, and svgo should be considered.
55
-
56
-
* Open a command prompt and run;
57
-
```
58
-
choco install nodejs -y
59
-
npm install
60
-
npm update
61
-
```
62
-
This should already install all required packages listed in ```package.json```.
63
-
* However, if a package was not found (e.g., svgo), try manually installing it by running:
64
-
```
65
-
npm install -g svgo
66
-
```
67
-
68
-
#### Building the Website (any platform)
69
-
70
-
* Auto rebuilding (on any change) and watching the website (stored in '_site') can be done by running (requires only jekyll)
71
-
```
72
-
jekyll serve
73
-
```
74
-
With the server running, the website should be available at http://localhost:4000.
48
+
### Deployment
49
+
- Commits trigger GitHub Actions, which deploy updates to the `gh-pages` branch and are served directly from there.
0 commit comments