You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-14Lines changed: 19 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,11 @@
1
1
# Documentation and Tutorials for Turing.jl
2
2
3
3
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
-
5
4
- The `master` branch contains the quarto source
6
5
- The `gh-pages` branch contains the `html` version of these documents compiled from the `master` branch.
7
6
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).
11
9
12
10
Once you have the prerequisite installed, you can follow these steps:
13
11
@@ -23,27 +21,34 @@ Once you have the prerequisite installed, you can follow these steps:
23
21
cd docs
24
22
```
25
23
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:
27
31
28
32
```bash
29
33
quarto preview
30
34
```
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!
33
35
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:
35
40
36
41
```bash
37
42
quarto render
38
43
```
39
-
This will render the full website in`_site` folder.
40
44
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`:
42
48
43
-
```
44
-
cd somedocs # This is the folder containing a docs `qmd` file.
0 commit comments