Skip to content

Commit 8882bc8

Browse files
committed
docs: add Node setup instructions
1 parent 890e27e commit 8882bc8

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,21 @@ Install the Python dependencies listed in `requirements.txt` with:
2121
pip install -r requirements.txt
2222
```
2323

24+
To work with the JavaScript that powers the theme you'll also need Node
25+
dependencies. Install them with:
26+
27+
```bash
28+
npm install
29+
```
30+
31+
Bundled JavaScript is compiled from the source files in `assets/js/`. Run the
32+
following to create `main.min.js` (minified with a banner) or watch for changes:
33+
34+
```bash
35+
npm run build:js # minify and add banner
36+
npm run watch:js # optional: automatically rebuild on changes
37+
```
38+
2439
# ToDo
2540

2641
Have a consistency in the font and font sizes (ideally you want to use 2 fonts. One for the header/subtitle and one for the text. You can use this kind of website https://fontjoy.com/ which allow you to pair fonts).

0 commit comments

Comments
 (0)