diff --git a/README.md b/README.md index 8d14fddc1b5343ab3599782e60022586a6d2e8a3..9ad1d61b55b0907ca06c92e32967b4d16fe2538a 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ title: "Website template using Quarto" ## What is Quarto? -Per the [official website](https://quarto.org): +Per the Quarto [official website](https://quarto.org): > Quarto is an open-source scientific and technical publishing system built on Pandoc > @@ -46,3 +46,34 @@ Per the [official website](https://quarto.org): - R console: + only build: [`quarto::quarto_render()`](https://quarto-dev.github.io/quarto-r/reference/quarto_render.html) + build + preview: [`quarto::quarto_preview()`](https://quarto-dev.github.io/quarto-r/reference/quarto_preview.html) + +## Quarto markdown files + +Use Quarto markdown (`.qmd`) files to write your contents, following the [standard Markdown syntax](https://quarto.org/docs/authoring/markdown-basics.html) with the additional features to run computations, similarly to [Rmarkdown](https://rmarkdown.rstudio.com/). + +### Running computations + +You can include code chunks between ```` ```{r} ```` and ```` ``` ```` markers (with the name of the language between `{ }`), and the code as well as its output will be included, e.g. in R: + +```{r} +x <- seq(0, 10, 0.1) +plot(x, cos(x)) +``` + +[R](https://quarto.org/docs/computations/r.html), [Python](https://quarto.org/docs/computations/python.html) and [Julia](https://quarto.org/docs/computations/julia.html) programming languages are supported, e.g. in Python: + +```{python} +a = [] +for i in range(10): + a.append(2*i) +print(a) +``` + +> Note: +> +> - Running R codes requires the `knitr` R package. +> - Running Python codes requires the `reticulate` R package when using Rstudio, and the `jupyter` Python package when using the command line interface. + +### Additional tips + +You can include markdown (`.md`) files inside `.qmd` file with the following `{{< include my_file.md >}}`. diff --git a/index.qmd b/index.qmd index 0da433c83f0faa42b6d668b5f41fcd36c173c05c..c82ccd25be023cb2562e1bd9413882b0cd1d0ca7 100644 --- a/index.qmd +++ b/index.qmd @@ -5,37 +5,3 @@ title: "Quarto Website Template" This is a Quarto website using Markdown files to write contents. {{< include README.md >}} - -## Quarto markdown files - -Use Quarto markdown (`.qmd`) files to write your contents, following the [standard Markdown syntax](https://quarto.org/docs/authoring/markdown-basics.html) with the additional features to run computations, similarly to [Rmarkdown](https://rmarkdown.rstudio.com/). - -### Running computations - -You can include code chunks between ```` ```{r} ```` and ```` ``` ```` markers (with the name of the language between `{ }`), and the code as well as its output will be included, e.g. in R: - -```{r} -x <- seq(0, 10, 0.1) -plot(x, cos(x)) -``` - -[R](https://quarto.org/docs/computations/r.html), [Python](https://quarto.org/docs/computations/python.html) and [Julia](https://quarto.org/docs/computations/julia.html) programming languages are supported, e.g. in Python: - -```{python} -a = [] -for i in range(10): - a.append(2*i) -print(a) -``` - -> Note on Python: -> -> - If you use Rstudio, running R codes works seamlessly, running Python codes require to install the `reticulate` R package. -> - From the command line, you will need the `jupyter` Python packate. - -### Additional tips - -You can include markdown (`.md`) files inside `.qmd` file with the following: -```` markdown -{{< include my_file.md >}} -````