Skip to content

Commit 3c4729f

Browse files
committed
Add information to the README about how to test the website locally
1 parent 4e4a5e6 commit 3c4729f

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,39 @@
11
# https://juliaparallel.org
2+
3+
## For contributors
4+
5+
Clone the repository and `cd` to the new directory. Edit the files as you need. To test the
6+
website locally, start julia with `julia --project` and do
7+
8+
```julia
9+
julia> import Pkg
10+
11+
julia> Pkg.instantiate()
12+
13+
julia> import Xranklin
14+
15+
julia> Xranklin.serve()
16+
Activating project at `~/repo/juliaparallel.github.io`
17+
[ Info: 📓 de-serializing global context...
18+
[ Info: ⌛ processing config.md
19+
[ Info: ... [config.md] ✔ (δt = 2.1s)
20+
[ Info: 📓 de-serializing 0 local contexts...
21+
[ Info: 💡 de-serialization done (δt = 2.7s)
22+
23+
[ Info: 💡 starting the full pass
24+
25+
[ Info: > Full Pass [MD/1]
26+
[ Info: > Full Pass [MD/I]
27+
[ Info: > Full Pass [MD/2]
28+
[ Info: > Full Pass [O]
29+
[ Info: 🧵 loop (n=1) over 121 items
30+
31+
[ Info: 💡 full pass done (δt = 5.9s)
32+
33+
[ Info: Listening on: 127.0.0.1:8000
34+
✓ LiveServer listening on http://localhost:8000/ ...
35+
(use CTRL+C to shut down)
36+
```
37+
38+
Navigate to `localhost:8000` in a browser and you should see a preview of any modifications
39+
you make locally.

0 commit comments

Comments
 (0)