Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bearloga/wikipediapreview-r
R package for using Wikipedia Preview context cards in R Markdown documents
https://github.com/bearloga/wikipediapreview-r
Last synced: about 1 month ago
JSON representation
R package for using Wikipedia Preview context cards in R Markdown documents
- Host: GitHub
- URL: https://github.com/bearloga/wikipediapreview-r
- Owner: bearloga
- License: other
- Created: 2022-04-08T23:10:16.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-24T03:21:41.000Z (6 months ago)
- Last Synced: 2024-08-13T07:11:46.632Z (4 months ago)
- Language: R
- Homepage: https://bearloga.github.io/wikipediapreview-r/
- Size: 3.77 MB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - bearloga/wikipediapreview-r - R package for using Wikipedia Preview context cards in R Markdown documents (R)
README
# wikipediapreview
[Wikipedia Preview](https://www.mediawiki.org/wiki/Wikipedia_Preview) for [R Markdown](https://rmarkdown.rstudio.com/) documents.
| Format/Generator | Compatibility |
|:-----------------|:--------------|
| [blogdown](https://pkgs.rstudio.com/blogdown/) blog/website | ✅ Confirmed |
| [bookdown](https://pkgs.rstudio.com/bookdown/) website | ❔ Unknown |
| [distill](https://rstudio.github.io/distill/) article | ✅ Confirmed |
| [distill](https://rstudio.github.io/distill/) blog/website | ❔ Unknown (but probably works) |
| HTML Vignette/Document | ✅ Confirmed |
| [pkgdown](https://pkgdown.r-lib.org/) article | ✅ Confirmed |
| [Quarto](https://quarto.org/) HTML documents | ✅ Confirmed |
| [Quarto](https://quarto.org/) blog/website | ✅ Confirmed |
| [Quarto presentation](https://quarto.org/docs/presentations/revealjs/) | ✔️ Confirmed _BUT_ using alternative styling is not recommended |
| [Reveal.js](https://github.com/rstudio/revealjs) presentation | ✔️ Confirmed _BUT_ using alternative styling is not recommended |
| [xaringan](https://github.com/yihui/xaringan) presentation | ✔️ Confirmed _BUT_ `{.wiki}` styling does not work |
**NOTE**: Wikipedia Preview [standalone JS component](https://github.com/wikimedia/wikipedia-preview) can be used on any website. There is also an [official WordPress plug-in](https://wordpress.org/plugins/wikipedia-preview/).
## Installation
You can install the development version of wikipediapreview like so:
``` r
# install.packages("remotes")
remotes::install_github("bearloga/wikipediapreview-r")
```
## Example
To initialize include the following anywhere in your R Markdown document:
```
`r wikipediapreview::wp_init()`
```
If you prefer, you can initialize using a designated chunk instead:
````{verbatim}
```{r wp-init, results='asis', echo=FALSE}
library(wikipediapreview)
wp_init()
```
````
Links to Wikipedia articles in your R Markdown document will automatically have popup cards showing your readers a preview of the linked article:
## 1.8.0
This package uses version 1.8.0 of Wikipedia Preview while the latest version (as of 2024-06-23) is 1.11.0 and includes awesome improvements like multiple color schemes (night/dark mode).
However, starting with 1.9.0, the maintainers of the library have been distributing a CommonJS version (`.cjs`). [Unpkg has an unresolved issue](https://github.com/mjackson/unpkg/issues/355) where it does not correctly set the content type of `.cjs` files -- it serves them as "text/plain" instead of "application/javascript" -- which sets off an "blocked due to MIME type mismatch (X-Content-Type-Options: nosniff)" error when the browser tries to load it from unpkg's servers.
Until that issue is resolved, this package cannot use the latest version of Wikipedia Preview library.