tweak vignettes

yihui · Nov 8, 2024 · 9eb1074 · 9eb1074
1 parent c43fda0
commit 9eb1074
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 9 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: knitr
 Type: Package
 Title: A General-Purpose Package for Dynamic Report Generation in R
-Version: 1.49
+Version: 1.49.1
 Authors@R: c(
     person("Yihui", "Xie", role = c("aut", "cre"), email = "xie@yihui.name", comment = c(ORCID = "0000-0003-0645-5666")),
     person("Abhraneel", "Sarma", role = "ctb"),

diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,5 @@
+# CHANGES IN knitr VERSION 1.50
+
 # CHANGES IN knitr VERSION 1.49
 
 ## NEW FEATURES

diff --git a/vignettes/knitr-intro.Rmd b/vignettes/knitr-intro.Rmd
@@ -20,8 +20,7 @@ manual](https://yihui.org/knitr/demo/graphics/) ), and remember to read the help
 pages of functions in this package. There is a book "Dynamic Docuemnts with R
 and knitr" for this package, too.
 
-Anyway, here is a code chunk that shows you can compile vignettes with **knitr**
-as well using R 3.0.x, which supports non-Sweave vignettes:
+Below are code chunk examples:
 
 ```{r show-off}
 options(digits = 4)

diff --git a/vignettes/knitr-markdown.Rmd b/vignettes/knitr-markdown.Rmd
@@ -1,5 +1,5 @@
 ---
-title: R Markdown (v1) Vignettes with knitr
+title: R Markdown Vignettes with litedown
 author: Yihui Xie
 date: "`{r} Sys.Date()`"
 output:
@@ -10,24 +10,24 @@ output:
 
 <!--
 %\VignetteEngine{litedown::vignette}
-%\VignetteIndexEntry{An R Markdown Vignette with knitr}
+%\VignetteIndexEntry{R Markdown Vignettes with litedown}
 -->
 
 Before R 3.0.0, only Sweave/PDF vignettes were supported in R. Markdown is gaining popularity over the years due to its simplicity, and R 3.0.0 starts to support package vignettes written in R Markdown.
 
-> Please note this example is for [R Markdown v1](https://cran.r-project.org/package=markdown) only. If you use [R Markdown v2](https://rmarkdown.rstudio.com), you should use the vignette engine `knitr::rmarkdown` instead of `knitr::knitr`.
+> Please note this example is for [litedown](https://cran.r-project.org/package=litedown). If you use [R Markdown v2](https://rmarkdown.rstudio.com), you should use the vignette engine `knitr::rmarkdown` instead of `litedown::vignette`.
 
 ## Package vignettes
 
 To enable Markdown vignettes in an R package, you need to
 
 - add `*.Rmd` files under the `vignettes` directory
-- add `VignetteBuilder: knitr` to the `DESCRIPTION` file
-- specify the vignette engine `\VignetteEngine{knitr::knitr}` in the `Rmd` files (inside HTML comments)
+- add `VignetteBuilder: litedown` to the `DESCRIPTION` file
+- specify the vignette engine `\VignetteEngine{litedown::vignette}` in the `Rmd` files (inside HTML comments)
 
 ## View vignettes
 
-And R will load the **knitr** package to build these vignettes to HTML files, and you can see them when you open the HTML help:
+And R will load the **litedown** package to build these vignettes to HTML files, and you can see them when you open the HTML help:
 
 ```{r eval=FALSE}
 help(package = 'YourPackage', help_type = 'html')