search

spyrales / gouvdown

French government design system for R Markdown
https://spyrales.github.io/gouvdown/
European Union Public License 1.2
48 stars 4 forks source link

Documentation of html gouv #45

Open pachevalier opened 2 years ago

pachevalier commented 2 years ago

In the documentation of html_gouv(), it is written that it can be passed as a parameter to rmarkdown:render() https://github.com/spyrales/gouvdown/blob/master/man/html_gouv.Rd#L29. Which parameter is it ?

Should we have the following syntax ? render(input = "index.Rmd", params = html_gouv(logo = "gouvernement"))

It would be useful to add an example.

cdugeai commented 2 years ago

I had the same issue. But the doc reads:

An R Markdown output format object to be passed to rmarkdown::render().

So I guessed that the parameter to use was output_format like so:

rmarkdown::render(input = "<your-filename>.Rmd", output_format = html_gouv())

This command seems to work well but I have another proxy error when the script tries to download a font called Spectral so the command crashed.