You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: vignettes/test-quarto.qmd
+47-24Lines changed: 47 additions & 24 deletions
Original file line number
Diff line number
Diff line change
@@ -13,41 +13,63 @@ knitr:
13
13
comment: '#>'
14
14
---
15
15
16
-
pkgdown effectively uses quarto only to generate HTML and then supplies its own CSS and JS. This means that when quarto introduces new features, pkgdown may lag behind in their support. If you're trying out something that doesn't work (and isn't mentioned explicitly below), please [file an issue](https://github.com/r-lib/pkgdown/issues) so we can look into it.
16
+
pkgdown effectively uses quarto only to generate HTML and then supplies its own
17
+
CSS and JS. This means that when quarto introduces new features, pkgdown may lag
18
+
behind in their support. If you're trying out something that doesn't work (and
19
+
isn't mentioned explicitly below), please [file an
20
+
issue](https://github.com/r-lib/pkgdown/issues) so we can look into it.
17
21
18
22
## Operation
19
23
20
-
pkgdown turns your articles directory into a quarto project by temporarily adding a `_quarto.yml` to your articles. You can also add your own if you want to control options for all quarto articles. If you do so, and you have a mix of `.qmd` and `.Rmd` files, you'll need to include the following yaml so that RMarkdown can continue to handle the .Rmd files:
24
+
pkgdown turns your articles directory into a quarto project by temporarily
25
+
adding a `_quarto.yml` to your articles. You can also add your own if you want
26
+
to control options for all quarto articles. If you do so, and you have a mix of
27
+
`.qmd` and `.Rmd` files, you'll need to include the following yaml so that
28
+
RMarkdown can continue to handle the .Rmd files:
21
29
22
-
```yaml
30
+
```yaml
23
31
project:
24
32
render: ['*.qmd']
25
33
```
26
34
27
35
### GitHub Actions
28
36
29
-
The `setup-r-dependencies` action will [automatically](https://github.com/r-lib/actions/tree/v2-branch/setup-r-dependencies#usage) install Quarto in your GitHub Actions if a .qmd file is present in your repository (see the `install-quarto` parameter for more details).
* pkgdown assumes that you're using [quarto vignette style](https://quarto-dev.github.io/quarto-r/articles/hello.html), or more generally an html format with [`minimal: true`](https://quarto.org/docs/output-formats/html-basics.html#minimal-html). Specifically, only HTML vignettes are currently supported.
47
+
- pkgdown assumes that you're using [quarto vignette
48
+
style](https://quarto-dev.github.io/quarto-r/articles/hello.html), or more
Specifically, only HTML vignettes are currently supported.
37
52
38
-
* You can't customise mermaid styles with quarto mermaid themes. If you want to change the colours, you'll need to provide your own custom CSS as shown in [the quarto docs](https://quarto.org/docs/authoring/diagrams.html#customizing-mermaid).
53
+
- You can't customise mermaid styles with quarto mermaid themes. If you want
54
+
to change the colours, you'll need to provide your own custom CSS as shown
* pkgdown will pass the `lang` setting on to quarto, but the set of available languages is not perfectly matched. Learn more in <https://quarto.org/docs/authoring/language.html>, including how to supply your own translations.
58
+
- pkgdown will pass the `lang` setting on to quarto, but the set of available
59
+
languages is not perfectly matched. Learn more in
60
+
<https://quarto.org/docs/authoring/language.html>, including how to supply
61
+
your own translations.
41
62
42
63
## Supported features
43
64
44
-
The following sections demonstrate a bunch of useful quarto features so that we can make sure that they work.
65
+
The following sections demonstrate a bunch of useful quarto features so that we
66
+
can make sure that they work.
45
67
46
68
### Inline formatting
47
69
48
-
* [Small caps]{.smallcaps}
70
+
- [Small caps]{.smallcaps}
49
71
50
-
* Here is a footnote reference[^1]
72
+
- Here is a footnote reference[^1]
51
73
52
74
[^1]: And here is the footnote.
53
75
@@ -63,7 +85,7 @@ plot(1:3)
63
85
64
86
### Figures
65
87
66
-
::: {#fig-puppies layout-ncol=2}
88
+
::: {#fig-puppies layout-ncol="2"}
67
89
{#fig-pitbull}
68
90
69
91
{#fig-shar-pei}
This vignette tests has a very long TOC. You should be able to navigate to a heading near the bottom of the doc without having to scroll all the way down.
10
+
This vignette tests has a very long TOC. You should be able to navigate to a
11
+
heading near the bottom of the doc without having to scroll all the way down.
0 commit comments