Skip to content

Commit 33381db

Browse files
committed
Update README following #497
1 parent c0dc95b commit 33381db

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

README.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Documentation and Tutorials for Turing.jl
22

33
This repository is part of [Turing.jl's](https://turinglang.org/) website (i.e. `https://turinglang.org/docs/`). It contains the Turing.jl documentation and tutorials.
4-
54
- The `master` branch contains the quarto source
65
- The `gh-pages` branch contains the `html` version of these documents compiled from the `master` branch.
76

@@ -23,27 +22,35 @@ Once you have the prerequisite installed, you can follow these steps:
2322
cd docs
2423
```
2524

26-
3. Preview the website using Quarto Preview:
25+
3. Instantiate the project environment:
26+
27+
```bash
28+
julia --project=. -e 'using Pkg; Pkg.instantiate()'
29+
```
30+
31+
4. Preview the website using Quarto Preview:
2732

2833
```bash
2934
quarto preview
3035
```
31-
This will launch a local server at http://localhost:4200/, which you can view in your web browser by navigating to the link shown in your terminal.
32-
Note: Avoid clicking links in the navbar while previewing locally because they will eventually lead to https links online!
3336

34-
4. Render the website locally:
37+
This will launch a local server at http://localhost:4200/, which you can view in your web browser by navigating to the link shown in your terminal.
38+
Note: Avoid clicking links in the navbar while previewing locally because they will eventually lead to https links online!
39+
40+
5. Render the website locally:
3541

3642
```bash
3743
quarto render
3844
```
39-
This will render the full website in `_site` folder.
4045

41-
It is also possible to render a single tutorial or `qmd` file without compiling the entire site. This is often helpful to speed up compilation when editing a single docs page. To do this, first `cd` to the file's folder, and run `quarto preview` or `quarto render`:
46+
This will render the full website in `_site` folder.
47+
48+
It is also possible to render a single tutorial or `qmd` file without compiling the entire site. This is often helpful to speed up compilation when editing a single docs page. To do this, first `cd` to the file's folder, and run `quarto preview` or `quarto render`:
4249
43-
```
44-
cd somedocs # This is the folder containing a docs `qmd` file.
45-
quarto render index.qmd
46-
```
50+
```
51+
cd somedocs # This is the folder containing a docs `qmd` file.
52+
quarto render index.qmd
53+
```
4754
4855
## License
4956

0 commit comments

Comments
 (0)