Skip to content

Commit fddcda8

Browse files
authored
Documentation for enabling math rendering (#195)
1 parent f6f750c commit fddcda8

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

vignettes/hello.qmd

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,21 +42,22 @@ format:
4242
css: custom.css
4343
```
4444
45-
All those configurations are set in way that they can't be override by YAML header in the vignette source file. Only new configuration can be set, e.g adding a Table Of Content:
45+
All those configurations are set in way that they can't be overriden by the YAML header in the vignette source file and only new configurations can be set. Typical examples for such configurations are adding a [table of contents](https://quarto.org/docs/reference/formats/html.html#table-of-contents) or enabling the rendering of mathematical notation in the [format options](https://quarto.org/docs/reference/formats/html.html#format-options), e.g., by MathJax. Specifically, these two options can be set in the following way:
4646
4747
````yaml
4848
format:
4949
html:
5050
toc: true
51+
html-math-method: mathjax
5152
vignette: >
5253
%\VignetteIndexEntry{Vignette's Title}
5354
%\VignetteEngine{quarto::html}
5455
%\VignetteEncoding{UTF-8}
5556
````
5657
57-
This is one limitation of the current implementation of the vignette engine. This is to insure HTML vignette produced are reasonable in size and can be published on CRAN without problem.
58+
The minimal default format is a deliberate limitation of the current implementation of the vignette engine. It ensures that the HTML vignettes produced are reasonable in size and can be published on CRAN without problems.
5859
59-
The other limitation concerns the interactive rendering. If you render your vignette `.qmd` file using `quarto render` or any other function, the output will be based on default HTML format from Quarto and not the vignette engine one. Only building the vignette will produce the real results. More about building vignette in the [R Packages (2e)](https://r-pkgs.org/vignettes.html#sec-vignettes-how-built-checked) book.
60+
Another limitation concerns the interactive rendering. If you render your vignette `.qmd` file using `quarto render` or any other function, the output will be based on the default HTML format from Quarto and not the vignette engine one. Only building the vignette will produce the real results. More details about building vignettes are available in the [R Packages (2e)](https://r-pkgs.org/vignettes.html#sec-vignettes-how-built-checked) book.
6061

6162
Intermediates resources that would be created by an authoring workflow that would `quarto render` with default `format: html` should be ignored in package sources.
6263

0 commit comments

Comments
 (0)