news_to_md: Converts a traditional NEWS files into a Markdown NEWS.md...

In HenrikBengtsson/pkgdown.extras: Enhancing the 'pkgdown' Package

Converts a traditional NEWS files into a Markdown NEWS.md File

Description

Converts a traditional NEWS files into a Markdown NEWS.md File

Usage

news_to_md(
  pkg = ".",
  input = "NEWS",
  output = "NEWS.md",
  overwrite = FALSE,
  package = NULL,
  style = c("NEWS", "pkgdown"),
  category_case = c("TitleCase", "as-is"),
  escape = TRUE,
  verbose = FALSE
)

Arguments

pkg	Package path.
input	The name of the input ‘NEWS’ file.
output	The name of the output ‘NEWS.md’ file.
overwrite	If TRUE, an existing output file is overwritten.
package	The name of the package. If not specified, it is inferred from the ‘DESCRIPTION’ file.
style	The style of the ‘NEWS.md’ file.
category_case	The style of the category headers.
escape	If TRUE, symbols that have special meaning in Markdown are escaped.
verbose	If TRUE, a summary of the parsed ‘NEWS’ file is outputted. This can be useful to identify mistypes category titles.

Value

(invisible) The Markdown output.

HenrikBengtsson/pkgdown.extras documentation built on Aug. 12, 2024, 7:33 p.m.