Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

vignette render with markdown rather than rmarkdown #5773

Merged
merged 2 commits into from
Dec 2, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Version: 1.14.9
Title: Extension of `data.frame`
Depends: R (>= 3.1.0)
Imports: methods
Suggests: bit64 (>= 4.0.0), bit (>= 4.0.4), curl, R.utils, xts, zoo (>= 1.8-1), yaml, knitr, rmarkdown, markdown
Suggests: bit64 (>= 4.0.0), bit (>= 4.0.4), curl, R.utils, xts, zoo (>= 1.8-1), yaml, knitr, markdown
Description: Fast aggregation of large data (e.g. 100GB in RAM), fast ordered joins, fast add/modify/delete of columns by group using no copies at all, list columns, friendly and fast character-separated-value read/write. Offers a natural and flexible syntax, for faster development.
License: MPL-2.0 | file LICENSE
URL: https://r-datatable.com, https://Rdatatable.gitlab.io/data.table, https://github.com/Rdatatable/data.table
Expand Down
9 changes: 5 additions & 4 deletions vignettes/datatable-benchmarking.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: "Benchmarking data.table"
date: "`r Sys.Date()`"
output:
rmarkdown::html_vignette:
toc: true
number_sections: true
markdown::html_format:
options:
toc: true
number_sections: true
Comment on lines +5 to +8
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you want to style the TOC similarly to rmarkdown, you can provide the styles in an extra.css file, e.g.,

#TOC {
  border: 1px solid #ccc;
  border-radius: 5px;
  padding-left: 1em;
  background: #f6f6f6;
}

Then include this extra.css via:

Suggested change
markdown::html_format:
options:
toc: true
number_sections: true
markdown::html_format:
options:
toc: true
number_sections: true
meta:
css: [default, extra.css]

vignette: >
%\VignetteIndexEntry{Benchmarking data.table}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEngine{knitr::knitr}
\usepackage[utf8]{inputenc}
---

Expand Down
9 changes: 5 additions & 4 deletions vignettes/datatable-faq.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: "Frequently Asked Questions about data.table"
date: "`r Sys.Date()`"
output:
rmarkdown::html_vignette:
toc: true
number_sections: true
markdown::html_format:
options:
toc: true
number_sections: true
vignette: >
%\VignetteIndexEntry{Frequently Asked Questions about data.table}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEngine{knitr::knitr}
\usepackage[utf8]{inputenc}
---

Expand Down
4 changes: 2 additions & 2 deletions vignettes/datatable-importing.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: "Importing data.table"
date: "`r Sys.Date()`"
output:
rmarkdown::html_vignette
markdown::html_format
vignette: >
%\VignetteIndexEntry{Importing data.table}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEngine{knitr::knitr}
\usepackage[utf8]{inputenc}
---

Expand Down
4 changes: 2 additions & 2 deletions vignettes/datatable-intro.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: "Introduction to data.table"
date: "`r Sys.Date()`"
output:
rmarkdown::html_vignette
markdown::html_format
vignette: >
%\VignetteIndexEntry{Introduction to data.table}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEngine{knitr::knitr}
\usepackage[utf8]{inputenc}
---

Expand Down
4 changes: 2 additions & 2 deletions vignettes/datatable-keys-fast-subset.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: "Keys and fast binary search based subset"
date: "`r Sys.Date()`"
output:
rmarkdown::html_vignette
markdown::html_format
vignette: >
%\VignetteIndexEntry{Keys and fast binary search based subset}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEngine{knitr::knitr}
\usepackage[utf8]{inputenc}
---

Expand Down
4 changes: 2 additions & 2 deletions vignettes/datatable-programming.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: "Programming on data.table"
date: "`r Sys.Date()`"
output:
rmarkdown::html_vignette
markdown::html_format
vignette: >
%\VignetteIndexEntry{Programming on data.table}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEngine{knitr::knitr}
\usepackage[utf8]{inputenc}
---

Expand Down
4 changes: 2 additions & 2 deletions vignettes/datatable-reference-semantics.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: "Reference semantics"
date: "`r Sys.Date()`"
output:
rmarkdown::html_vignette
markdown::html_format
vignette: >
%\VignetteIndexEntry{Reference semantics}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEngine{knitr::knitr}
\usepackage[utf8]{inputenc}
---

Expand Down
4 changes: 2 additions & 2 deletions vignettes/datatable-reshape.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: "Efficient reshaping using data.tables"
date: "`r Sys.Date()`"
output:
rmarkdown::html_vignette
markdown::html_format
vignette: >
%\VignetteIndexEntry{Efficient reshaping using data.tables}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEngine{knitr::knitr}
\usepackage[utf8]{inputenc}
---

Expand Down
9 changes: 5 additions & 4 deletions vignettes/datatable-sd-usage.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: "Using .SD for Data Analysis"
date: "`r Sys.Date()`"
output:
rmarkdown::html_vignette:
toc: true
number_sections: true
markdown::html_format:
options:
toc: true
number_sections: true
vignette: >
%\VignetteIndexEntry{Using .SD for Data Analysis}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEngine{knitr::knitr}
\usepackage[utf8]{inputenc}
---

Expand Down
4 changes: 2 additions & 2 deletions vignettes/datatable-secondary-indices-and-auto-indexing.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: "Secondary indices and auto indexing"
date: "`r Sys.Date()`"
output:
rmarkdown::html_vignette
markdown::html_format
vignette: >
%\VignetteIndexEntry{Secondary indices and auto indexing}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEngine{knitr::knitr}
\usepackage[utf8]{inputenc}
---

Expand Down
Loading