Comments (1)
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}
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
- https://r-pkgs.org/vignettes.html
- https://bookdown.org/yihui/rmarkdown/r-package-vignette.html
- https://bookdown.org/yihui/rmarkdown-cookbook/package-vignette.html
- https://blog.r-hub.io/2020/06/03/vignettes/
- https://cran.r-project.org/doc/manuals/r-release/R-exts.html#Non_002dSweave-vignettes
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)
- Upkeep for distill
- Check and add alt-text to pictures, plots, ... in website
- invalid byte sequence when deploying to github HOT 3
- RSS category-based feeds HOT 1
- Creative Commons Markdown Table Not Rendering Properly
- Warning due to deprecation of 'format' argument to 'as.character.POSIXlt()' HOT 2
- Description in _site.yaml causing Error "STRING_ELT() can only be applied to a 'character vector', not a 'list'" HOT 1
- How to add email and multiple affiliations to a single author? HOT 2
- Article description does not show up when adding posts HOT 1
- Improve alt-text for ORCiD icon HOT 3
- Add <hr> for screen reader accessibility HOT 1
- Space between lines in bulleted lists HOT 1
- Various minor accessibility issues
- Release distill 1.6
- Gallery outdated, remove Quarto pages HOT 1
- Javascript & D3 page error HOT 1
- Journal (site) title is incorrectly prepended to the article title in cititations.
- Has anyone used any alternative to Google analytics? HOT 2
- italicized species names in a Rmarkdown distill package
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from distill.