From d8bfef3568b3e52523760c9666c8b8f5c07d10ef Mon Sep 17 00:00:00 2001 From: Hong Ge <3279477+yebai@users.noreply.github.com> Date: Mon, 3 Jun 2024 12:05:26 +0100 Subject: [PATCH] add intruction on rendering single qmd --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b7245fb68..241d57dc1 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,9 @@ This repository contains the Turing.jl documentation and tutorials. - The `master` branch contains the quarto source -- The `gh-pages` branch contains the `html` version of these documents compiled from the `master` branch. +- The `gh-pages` branch contains the `html` version of these documents compiled from the `master` branch. + +This repository is part of [Turing.jl's](https://turinglang.org/) Website, i.e. `https://turinglang.org/docs/`. You can see the main website's repo [here](https://github.com/TuringLang/turinglang.github.io). To get started with the docs website locally, you'll need to have the following prerequisite installed: @@ -38,7 +40,12 @@ Note: Avoid clicking links in the navbar while previewing locally because they w ``` This will render the full website in `_site` folder. -This repository is part of [Turing.jl's](https://turinglang.org/) Website, i.e. `https://turinglang.org/docs/`. You can see the main website's repo [here](https://github.com/TuringLang/turinglang.github.io). +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 on a single docs page. To do this, first `cd` to the file's folder, and run `quarto preview` or `quarto render`: + +``` +cd folder_of_somedocs.qmd +quarto render somedocs.qmd +``` ## License