Skip to content

Commit c7ca0a3

Browse files
authored
add intruction on rendering single qmd (#469)
1 parent 58512b8 commit c7ca0a3

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
This repository contains the Turing.jl documentation and tutorials.
44

55
- The `master` branch contains the quarto source
6-
- The `gh-pages` branch contains the `html` version of these documents compiled from the `master` branch.
6+
- The `gh-pages` branch contains the `html` version of these documents compiled from the `master` branch.
7+
8+
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).
79

810
To get started with the docs website locally, you'll need to have the following prerequisite installed:
911

@@ -38,7 +40,12 @@ Note: Avoid clicking links in the navbar while previewing locally because they w
3840
```
3941
This will render the full website in `_site` folder.
4042

41-
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).
43+
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`:
44+
45+
```
46+
cd folder_of_somedocs.qmd
47+
quarto render somedocs.qmd
48+
```
4249
4350
## License
4451

0 commit comments

Comments
 (0)