Skip to content

Commit b4949a7

Browse files
authored
Update README following #497 (#506)
* Update README following #497 * Specify Quarto minimum version * Streamline instructions for rendering a single file
1 parent c0dc95b commit b4949a7

File tree

1 file changed

+19
-14
lines changed

1 file changed

+19
-14
lines changed

README.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
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

8-
To get started with the docs website locally, you'll need to have the following prerequisite installed:
9-
10-
- [Quarto](https://quarto.org/docs/download/)
7+
To get started with the docs website locally, you'll need to have [Quarto](https://quarto.org/docs/download/) installed.
8+
Make sure you have at least version 1.5 of Quarto installed, as this is required to correctly run [the native Julia engine](https://quarto.org/docs/computations/julia.html#using-the-julia-engine).
119

1210
Once you have the prerequisite installed, you can follow these steps:
1311

@@ -23,27 +21,34 @@ Once you have the prerequisite installed, you can follow these steps:
2321
cd docs
2422
```
2523

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

2832
```bash
2933
quarto preview
3034
```
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!
3335

34-
4. Render the website locally:
36+
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.
37+
Note: Avoid clicking links in the navbar while previewing locally because they will eventually lead to https links online!
38+
39+
5. Render the website locally:
3540

3641
```bash
3742
quarto render
3843
```
39-
This will render the full website in `_site` folder.
4044

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`:
45+
This will render the full website in `_site` folder.
46+
47+
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, pass the `qmd` file as an argument to `quarto render`:
4248

43-
```
44-
cd somedocs # This is the folder containing a docs `qmd` file.
45-
quarto render index.qmd
46-
```
49+
```
50+
quarto render path/to/index.qmd
51+
```
4752

4853
## License
4954

0 commit comments

Comments
 (0)