This repository is part of Turing.jl's 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 thehtml
version of these documents compiled from themaster
branch.
To get started with the docs website locally, you'll need to have the following prerequisite installed:
Once you have the prerequisite installed, you can follow these steps:
-
Clone this repository:
git clone https://github.com/TuringLang/docs
-
Navigate into the cloned directory:
cd docs
-
Preview the website using Quarto Preview:
quarto preview
This will launch a local server at http://localhost:4200/, which you can view in your web browser by navigating to the link shown in your terminal. Note: Avoid clicking links in the navbar while previewing locally because they will eventually lead to https links online!
-
Render the website locally:
quarto render
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 somedocs # This is the folder containing a docs `qmd` file.
quarto render index.qmd
This project is licensed under the MIT License - see the LICENSE file for details.