Your is parsed in to sections based on your use of headings.

build_news(pkg = ".", override = list(), preview = NA)



Path to package.


An optional named list used to temporarily override values in _pkgdown.yml


If TRUE, or && interactive(), will preview freshly generated section in browser.


The file should be formatted with level one headings (#) containing the package name and version number, level two headings (##) with topic headings and lists of news bullets. Commonly used level two headings include 'Major changes', 'Bug fixes', or 'Minor changes'.

# pkgdown

## Major changes

- Fresh approach based on the staticdocs package. Site configuration now based
  on YAML files.

If the package is available on CRAN, release dates will be added to versions in level-one headings, and "Unreleased" will be added versions that are not on CRAN.

Issues and contributors mentioned in news items are automatically linked to github if a URL entry linking to is provided in the package DESCRIPTION.

## Major changes

- Lots of bug fixes (@hadley, #100)

YAML config

To automatically link to release announcements, include a releases section.

 - text: "usethis 1.3.0"
 - text: "usethis 1.0.0 (and 1.1.0)"

Control whether news is present on one page or multiple pages with the one_page field. The default is true.

- one_page: false

See also