Skip to content

Commit 02af78f

Browse files
committed
Franklin instructions
1 parent a936a01 commit 02af78f

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

.gitattributes

+1
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
page/* linguist-vendored
2+
* text=auto

website/HOW TO RUN LOCALLY.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# 18S191 course website
2+
3+
The website was written in Franklin.jl - a static site generator with Julia as templating language.
4+
5+
Whenever you push to this folder of the repository, the website will automatically rebuild and update. To test your changes locally before pushing, follow these steps:
6+
7+
1. In a terminal, navigate to this folder using `cd`.
8+
2. Run Julia with this folder as the active project, and `instantiate`:
9+
```
10+
$ julia --project
11+
julia> ]
12+
(website) pkg> instantiate
13+
```
14+
3. Import & run our buddy Franklin:
15+
```
16+
julia> using Franklin
17+
# ignore some warnings
18+
julia> serve()
19+
```
20+
21+
Franklin will now launch a _live dev server_: whenever you change a file, your browser tab will automatically refresh.

0 commit comments

Comments
 (0)