Skip to content
Snippets Groups Projects
Commit e931dbd0 authored by GD's avatar GD
Browse files

include README in the index page

parent 37f25887
No related branches found
No related tags found
No related merge requests found
......@@ -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 >}}`.
......@@ -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 >}}
````
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment