Skip to content

Commit

Permalink
Expand section on local rendering in README (#545)
Browse files Browse the repository at this point in the history
  • Loading branch information
penelopeysm authored Nov 2, 2024
1 parent 194f66f commit a528aa8
Showing 1 changed file with 20 additions and 5 deletions.
25 changes: 20 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,29 @@ Once you have the prerequisite installed, you can follow these steps:
quarto render
```

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

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`:

```
quarto render path/to/index.qmd
```bash
cd _site
python -m http.server 8000
```

Then, navigate to http://localhost:8000/ in your web browser.

Note that rendering the entire documentation site can take a long time (usually multiple hours).
If you wish to speed up local rendering, there are two options available:

- 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.
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.

- Alternatively, render a single tutorial or `qmd` file without compiling the entire site.
To do this, pass the `qmd` file as an argument to `quarto render`:

```
quarto render path/to/index.qmd
```

## Troubleshooting build issues

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.
Expand Down

0 comments on commit a528aa8

Please sign in to comment.