Skip to content

Commit

Permalink
Minor edits.
Browse files Browse the repository at this point in the history
  • Loading branch information
yebai authored May 24, 2024
1 parent 145c6fa commit 8d596ba
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
# Documentation and Tutorials for Turing.jl

This repository's `master` branch contains the quarto source for the Turing.jl documentation and tutorials. The `gh-pages` branch contains the compiled `html` version of these documents.
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.

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/)

Once you have prerequisite installed, you can follow these steps:
Once you have the prerequisite installed, you can follow these steps:

1. Clone this repository:

Expand All @@ -26,7 +29,7 @@ Once you have prerequisite installed, you can follow these steps:
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 navbar while previewing locally because they will eventually lead to https links online!
Note: Avoid clicking links in the navbar while previewing locally because they will eventually lead to https links online!

4. Render the website locally:

Expand All @@ -35,7 +38,7 @@ Note: Avoid clicking links in navbar while previewing locally because they will
```
This will render the full website in `_site` folder.

his 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).
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).

## License

Expand Down

0 comments on commit 8d596ba

Please sign in to comment.