Code Monkey home page Code Monkey logo

Comments (1)

cderv avatar cderv commented on August 19, 2024

under pkgdown, I don't think the vignette format applies. pkgdown will use its own rendering and format to render in the website. See https://pkgdown.r-lib.org/reference/build_articles.html

Vignettes are rendered using a special document format that reconciles rmarkdown::html_document() with the pkgdown template. This means articles behave slightly differently to vignettes, particularly with respect to external files, and custom output formats. See below for more details.

So you can't really compare a vignette on CRAN and an article in a pkgdown website. The will look different.

Regarding your vignette, I looked at the source at https://github.com/ropensci/nuts/blob/main/vignettes/nuts.Rmd
You are using knitr engine for your vignette

vignette: >
  %\VignetteIndexEntry{nuts: Convert European Regional Data in R}
  %\VignetteEngine{knitr::knitr}

https://github.com/ropensci/nuts/blob/e50280efc18410b582e9eb9478af52e1f9e9106c/vignettes/nuts.Rmd#L12

This won't take into account rmarkdown format. It will be different that rmarkdown vignette engine.

I would suggest you read a bit more about how vignette are created, and works with R Markdown. Here are some resources that can help

Currently you are asking to use the knitr::knitr engine for vignettes, which is the R Markdown v1 historical engine documented at https://cran.r-project.org/web/packages/knitr/vignettes/knitr-markdown.html. A few packages provide their own vignette engine like markdown or minidown which will use their own rendering and formatting.

Remember that for vignettes R Markdown provides html_vignette format, because CRAN has constraints on file size and how resources are found. Using a complex format like distill will require some checks about size and how to include necessary resources in the package.

Hope this helps understand the situation here.

from distill.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.