Your is parsed in to sections based on your use of headings. Each minor version (i.e. the combination of first and second components) gets on one page, with all patch versions (i.e. the third component) on a single page. News items for development versions (by convention those versions with a fourth component) are displayed on an an "unreleased" page.

build_news(pkg = ".", path = "docs/news", one_page = TRUE, depth = 1L,
  preview = TRUE)



Path to source package. If R working directory is not set to the source directory, then pkg must be a fully qualified path to the source directory (not a relative path).


Output path. Relative paths are taken relative to the pkg directory.


If TRUE, writes all news to a single file. If FALSE, writes one file per major version.


Depth of path relative to root of documentation. Used to adjust relative links in the navbar.


If TRUE, will preview freshly generated news page


The file should be formatted somewhat like this:

# pkgdown
    ## Major changes
    - Fresh approach based on the staticdocs package. Site configuration now based on YAML files.

Commonly used subsection headers include 'Major changes', 'Bug fixes', 'Minor changes'.

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

There are currently no configuration options.