How to use _output.yml in packages?

I know we can use any HTML formats in vignettes on CRAN (e.g., Writing Vignettes with the ‘minidown’ Package).

I also want to know where should we locate _output.yml to share the settings among vignettes.
Is it package root or vignettes directory or some where else?

1 Like

Not sure if _output.yml is widely used in the vignette building scenario. It is possible that the logic of global setting using this file do not apply well due to how vignette works (vignettes/ folder then doc/

What did you try already ? Usually it should be in the root directory of the rmd file, so vignette directory ?

Know that you should be able to set a specific path per document.

output_yaml: <path/to/yaml>

in case it could be useful.

We could definitely adapt rmarkdown to make your scenario works if needed.

1 Like

Thanks, I once tried the root dir without success.
devtools::build_vignette infers the vignette directory is the location to put _output.yml.

The background of this question comes from

There, I discuss which features to be included by default.
However, I understand there is no default that can satisfy all users.
Now I think I should let almost all the features be opt-in.
Then, _output.yml would be a nice shortcut for users to prepare their own defaults.

1 Like

This topic was automatically closed 7 days after the last reply. New replies are no longer allowed.

If you have a query related to it or one of the replies, start a new topic and refer back with a link.