Skip to content

Commit a528aa8

Browse files
authored
Expand section on local rendering in README (#545)
1 parent 194f66f commit a528aa8

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,29 @@ Once you have the prerequisite installed, you can follow these steps:
4444
quarto render
4545
```
4646

47-
This will render the full website in `_site` folder.
47+
This will build the entire documentation and place the output in the `_site` folder.
48+
You can then view the rendered website by launching a HTTP server from that directory, e.g. using Python:
4849

49-
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`:
50-
51-
```
52-
quarto render path/to/index.qmd
50+
```bash
51+
cd _site
52+
python -m http.server 8000
5353
```
5454

55+
Then, navigate to http://localhost:8000/ in your web browser.
56+
57+
Note that rendering the entire documentation site can take a long time (usually multiple hours).
58+
If you wish to speed up local rendering, there are two options available:
59+
60+
- Download the most recent `_freeze` folder from the [GitHub releases of this repo](https://github.com/turinglang/docs/releases), and place it in the root of the project.
61+
This will allow Quarto to reuse the outputs of previous computations for any files which have not been changed since that `_freeze` folder was created.
62+
63+
- Alternatively, render a single tutorial or `qmd` file without compiling the entire site.
64+
To do this, pass the `qmd` file as an argument to `quarto render`:
65+
66+
```
67+
quarto render path/to/index.qmd
68+
```
69+
5570
## Troubleshooting build issues
5671

5772
As described in the [Quarto docs](https://quarto.org/docs/computations/julia.html#using-the-julia-engine), Quarto's Julia engine uses a worker process behind the scenes.

0 commit comments

Comments
 (0)