Skip to content

Commit 0ca8c7d

Browse files
authored
Update README.md
1 parent 3d566ef commit 0ca8c7d

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
# Documentation and Tutorials for Turing.jl
22

3-
This repository contains the Turing.jl documentation and tutorials.
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.
44

55
- The `master` branch contains the quarto source
66
- The `gh-pages` branch contains the `html` version of these documents compiled from the `master` branch.
77

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).
9-
108
To get started with the docs website locally, you'll need to have the following prerequisite installed:
119

1210
- [Quarto Pre-release](https://quarto.org/docs/download/)
@@ -43,8 +41,8 @@ This will render the full website in `_site` folder.
4341
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`:
4442
4543
```
46-
cd folder_of_somedocs.qmd
47-
quarto render somedocs.qmd
44+
cd somedocs # This is the folder containing a docs `qmd` file.
45+
quarto render index.qmd
4846
```
4947
5048
## License

0 commit comments

Comments
 (0)