Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Custom Quarto Extension/Template for Vignette Building #166

Open
jan-abel-inwt opened this issue Mar 22, 2024 · 3 comments
Open

Custom Quarto Extension/Template for Vignette Building #166

jan-abel-inwt opened this issue Mar 22, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@jan-abel-inwt
Copy link

Hi there, I just tested the feature of building vignettes with Quarto, and it works seamlessly!

I read this article which states that the following configuration can't be overridden:

format: 
  html:
    theme: none
    minimal: true
    embed-resources: true
    css: custom.css

I'm wondering how to build a vignette with my own custom Quarto extension/template. Is this possible?

@cderv
Copy link
Collaborator

cderv commented Mar 27, 2024

This is for more advanced usage, but you can use the special engine

%\VignetteEngine{quarto::format}

which will do whatever is configured in format key.

This is not yet fully documented as this is quite advanced usage to me and I am not yet sure of the possible side effect of creating vignette this way. They will use Quarto default if no format key is provided, and they are not meant for lightweight document which we usually expect for vignettes.

I'll add a note in documentation though to get more feedback on this.

Tips: To see all engine in a package you can do

library(quarto)
names(tools::vignetteEngine(package = "quarto"))
#> [1] "quarto::format" "quarto::html"   "quarto::pdf"

@cderv cderv added the documentation Improvements or additions to documentation label Mar 27, 2024
@cderv cderv added this to the next version milestone Mar 27, 2024
@jan-abel-inwt
Copy link
Author

Thanks a lot! It's working smoothly with our internal corporate design templates (pdf/html).

@cderv
Copy link
Collaborator

cderv commented Mar 27, 2024

Awesome !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants