diff --git a/README.md b/README.md index 45c24f469..82477b23c 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,10 @@ # Documentation and Tutorials for Turing.jl -This repository contains the Turing.jl documentation and tutorials. +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. - The `master` branch contains the quarto source - 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: - [Quarto Pre-release](https://quarto.org/docs/download/) @@ -43,8 +41,8 @@ This will render the full website in `_site` folder. 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`: ``` -cd folder_of_somedocs.qmd -quarto render somedocs.qmd +cd somedocs # This is the folder containing a docs `qmd` file. +quarto render index.qmd ``` ## License